Documentation: SphinxQuickstartTemplate.rst: add guidelines about highlighting

console sessions and add more highlighter names.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@170011 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Dmitri Gribenko 2012-12-12 20:07:18 +00:00
parent d52a2c0a31
commit 8ba48809c4

View File

@ -107,14 +107,15 @@ You can make blocks of code like this:
return 0 return 0
} }
For a shell session, use a ``bash`` code block: For a shell session, use a ``console`` code block:
.. code-block:: bash .. code-block:: console
$ echo "Goodbye cruel world!" $ echo "Goodbye cruel world!"
$ rm -rf / $ rm -rf /
If you need to show LLVM IR use the ``llvm`` code block. If you need to show LLVM IR use the ``llvm`` code block. Code blocks of ``c``,
``c++``, ``objc``, ``bash``, ``makefile`` kinds are supported.
You can show preformatted text without any syntax highlighting like this: You can show preformatted text without any syntax highlighting like this:
@ -136,6 +137,8 @@ You can show preformatted text without any syntax highlighting like this:
.++:.. .++:..
... ...
One can also use a ``none`` code block to turn off highlighting.
Hopefully you won't need to be this deep Hopefully you won't need to be this deep
"""""""""""""""""""""""""""""""""""""""" """"""""""""""""""""""""""""""""""""""""