IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

added documentation for lineno-match option

Browse Source
This commit is contained in:
Jeppe Pihl
2014-10-04 15:36:38 +02:00
parent bbfe4d3bb9
commit 5c48682cc9
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/markup/code.rst
View File

@@ -184,6 +184,10 @@ Includes
string option, only lines that precede the first lines containing that string string option, only lines that precede the first lines containing that string
are included. 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 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 ``prepend`` and ``append`` option, respectively. This is useful e.g. for
highlighting PHP code that doesn't include the ``<?php``/``?>`` markers. highlighting PHP code that doesn't include the ``<?php``/``?>`` markers.
@@ -195,8 +199,8 @@ Includes
.. literalinclude:: example.py .. literalinclude:: example.py
:diff: example.py.orig :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 .. versionadded:: 0.4.3
The ``encoding`` option. The ``encoding`` option.
@@ -207,6 +211,7 @@ Includes
The ``prepend`` and ``append`` options, as well as ``tab-width``. The ``prepend`` and ``append`` options, as well as ``tab-width``.
.. versionadded:: 1.3 .. versionadded:: 1.3
The ``diff`` option. The ``diff`` option.
The ``lineno-match`` option.
Showing a file name Showing a file name