aboutsummaryrefslogtreecommitdiffstats
path: root/docs/SphinxQuickstartTemplate.rst
diff options
context:
space:
mode:
authorDmitri Gribenko <gribozavr@gmail.com>2012-12-12 20:07:18 +0000
committerDmitri Gribenko <gribozavr@gmail.com>2012-12-12 20:07:18 +0000
commit8ba48809c418bc16050bb2d6335befcab13fc638 (patch)
tree420a4404934df43d8c42d37c960d8579addf3779 /docs/SphinxQuickstartTemplate.rst
parentd52a2c0a31a49e1a8fa16f6b975d01b1e934a49f (diff)
downloadexternal_llvm-8ba48809c418bc16050bb2d6335befcab13fc638.zip
external_llvm-8ba48809c418bc16050bb2d6335befcab13fc638.tar.gz
external_llvm-8ba48809c418bc16050bb2d6335befcab13fc638.tar.bz2
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
Diffstat (limited to 'docs/SphinxQuickstartTemplate.rst')
-rw-r--r--docs/SphinxQuickstartTemplate.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/SphinxQuickstartTemplate.rst b/docs/SphinxQuickstartTemplate.rst
index 640df63..1c03c97 100644
--- a/docs/SphinxQuickstartTemplate.rst
+++ b/docs/SphinxQuickstartTemplate.rst
@@ -107,14 +107,15 @@ You can make blocks of code like this:
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!"
$ 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:
@@ -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
""""""""""""""""""""""""""""""""""""""""