diff options
author | Georg Brandl <georg@python.org> | 2014-01-11 08:44:45 +0100 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2014-01-11 08:44:45 +0100 |
commit | 269ef714f34efd6fe98a4e7bde08bfb3b4928264 (patch) | |
tree | 7e1facc5fc101e3c21bedc7a2b8446aa346ecc13 /doc/markup/code.rst | |
parent | 5394fbb82bced4186afb3fd813e9ab1b089dce61 (diff) | |
download | sphinx-git-269ef714f34efd6fe98a4e7bde08bfb3b4928264.tar.gz |
Closes #668: Allow line numbering of ``code-block`` and ``literalinclude`` directives
#to start at an arbitrary line number, with a new ``lineno-start`` option.
Diffstat (limited to 'doc/markup/code.rst')
-rw-r--r-- | doc/markup/code.rst | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/doc/markup/code.rst b/doc/markup/code.rst index c0e7e8ebe..7b958bc9d 100644 --- a/doc/markup/code.rst +++ b/doc/markup/code.rst @@ -86,6 +86,14 @@ on line numbers for the individual block:: Some more Ruby code. +The first line number can be selected with the ``lineno-start`` option. If +present, ``linenos`` is automatically activated as well. + + .. code-block:: ruby + :lineno-start: 10 + + Some more Ruby code, with line numbering starting at 10. + Additionally, an ``emphasize-lines`` option can be given to have Pygments emphasize particular lines:: @@ -101,6 +109,9 @@ emphasize particular lines:: .. versionchanged:: 1.1 ``emphasize-lines`` has been added. +.. versionchanged:: 1.3 + ``lineno-start`` has been added. + Includes ^^^^^^^^ @@ -121,10 +132,11 @@ Includes Tabs in the input are expanded if you give a ``tab-width`` option with the desired tab width. - The directive also supports the ``linenos`` flag option to switch on line - numbers, the ``emphasize-lines`` option to emphasize particular lines, and - a ``language`` option to select a language different from the current - file's standard language. Example with options:: + Like :rst:dir:`code-block`, the directive supports the ``linenos`` flag + option to switch on line numbers, the ``lineno-start`` option to select the + first line number, the ``emphasize-lines`` option to emphasize particular + lines, and a ``language`` option to select a language different from the + current file's standard language. Example with options:: .. literalinclude:: example.rb :language: ruby |