diff options
Diffstat (limited to 'doc/markup/code.rst')
-rw-r--r-- | doc/markup/code.rst | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/doc/markup/code.rst b/doc/markup/code.rst index f69bb161b..b948dc386 100644 --- a/doc/markup/code.rst +++ b/doc/markup/code.rst @@ -36,21 +36,29 @@ installed) and handled in a smart way: highlighted as Python). * The highlighting language can be changed using the ``highlight`` directive, - used as follows:: + used as follows: - .. highlight:: c + .. rst:directive:: .. highlight:: language - This language is used until the next ``highlight`` directive is encountered. + Example:: + + .. highlight:: c + + This language is used until the next ``highlight`` directive is encountered. * For documents that have to show snippets in different languages, there's also a :rst:dir:`code-block` directive that is given the highlighting language - directly:: + directly: + + .. rst:directive:: .. code-block:: language + + Use it like this:: - .. code-block:: ruby + .. code-block:: ruby - Some Ruby code. + Some Ruby code. - The directive's alias name :rst:dir:`sourcecode` works as well. + The directive's alias name :rst:dir:`sourcecode` works as well. * The valid values for the highlighting language are: |