From 8ba48809c418bc16050bb2d6335befcab13fc638 Mon Sep 17 00:00:00 2001 From: Dmitri Gribenko Date: Wed, 12 Dec 2012 20:07:18 +0000 Subject: [PATCH] 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 --- docs/SphinxQuickstartTemplate.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/SphinxQuickstartTemplate.rst b/docs/SphinxQuickstartTemplate.rst index 640df63db1e..1c03c979f09 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 """""""""""""""""""""""""""""""""""""""" -- 2.34.1