diff options
| author | Jeppe Pihl <jpihl08@gmail.com> | 2014-10-04 15:36:38 +0200 |
|---|---|---|
| committer | Jeppe Pihl <jpihl08@gmail.com> | 2014-10-04 15:36:38 +0200 |
| commit | a961bae8cd1aa442629e1559828e7997916914a3 (patch) | |
| tree | 28a692ad6a3a904ec2c9ac2cf17ea4c883eb2f41 | |
| parent | 15f81d0de33e80311bfa312da4da05a5c4c7eb78 (diff) | |
| download | sphinx-a961bae8cd1aa442629e1559828e7997916914a3.tar.gz | |
added documentation for lineno-match option
| -rw-r--r-- | doc/markup/code.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/markup/code.rst b/doc/markup/code.rst index b948dc38..9a503519 100644 --- a/doc/markup/code.rst +++ b/doc/markup/code.rst @@ -184,6 +184,10 @@ Includes string option, only lines that precede the first lines containing that string are included. + When specifying particular parts of a file to display, it can be useful to + display exactly which lines are being presented. + This can be done using the ``lineno-match`` option. + You can prepend and/or append a line to the included code, using the ``prepend`` and ``append`` option, respectively. This is useful e.g. for highlighting PHP code that doesn't include the ``<?php``/``?>`` markers. @@ -195,8 +199,8 @@ Includes .. literalinclude:: example.py :diff: example.py.orig - This shows the diff between example.py and example.py.orig with unified diff format. - + This shows the diff between example.py and example.py.orig with unified diff + format. .. versionadded:: 0.4.3 The ``encoding`` option. @@ -207,6 +211,7 @@ Includes The ``prepend`` and ``append`` options, as well as ``tab-width``. .. versionadded:: 1.3 The ``diff`` option. + The ``lineno-match`` option. Showing a file name |