Documentation: SphinxQuickstartTemplate.rst: add guidelines about highlighting
authorDmitri Gribenko <gribozavr@gmail.com>
Wed, 12 Dec 2012 20:07:18 +0000 (20:07 +0000)
committerDmitri Gribenko <gribozavr@gmail.com>
Wed, 12 Dec 2012 20:07:18 +0000 (20:07 +0000)
console sessions and add more highlighter names.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@170011 91177308-0d34-0410-b5e6-96231b3b80d8

docs/SphinxQuickstartTemplate.rst

index 640df63db1ed95e407d1aa58a1f1ca43ac64ad3c..1c03c979f09f0645c0215857df2835c52dd0d621 100644 (file)
@@ -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
 """"""""""""""""""""""""""""""""""""""""