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

Add missing literalinclude options documentation

Browse Source 
The start-at and end-at options, added in 560b572 for v1.5a1, #625
weren't previously documented. This fixes that.
This commit is contained in:
Nicholas Devenish 2018-04-11 18:10:37 +01:00
parent b2bd9f75a6
commit 5685512e6a
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/usage/restructuredtext/directives.rst
View File

@ -596,7 +596,8 @@ __ http://pygments.org/docs/lexers/
``start-after`` is given as a string option, only lines that follow the ``start-after`` is given as a string option, only lines that follow the
first line containing that string are included. If ``end-before`` is given first line containing that string are included. If ``end-before`` is given
as a string option, only lines that precede the first lines containing that as a string option, only lines that precede the first lines containing that
string are included. string are included. The ``start-at`` and ``end-at`` options behave in a
similar way, but the lines containing the matched string are included.
With lines selected using ``start-after`` it is still possible to use With lines selected using ``start-after`` it is still possible to use
``lines``, the first allowed line having by convention the line number ``lines``, the first allowed line having by convention the line number
@ -638,6 +639,9 @@ __ http://pygments.org/docs/lexers/
Added the ``diff``, ``lineno-match``, ``caption``, ``name``, and Added the ``diff``, ``lineno-match``, ``caption``, ``name``, and
``dedent`` options. ``dedent`` options.
.. versionchanged:: 1.5
Added the ``start-at``, and ``end-at`` options.
.. versionchanged:: 1.6 .. versionchanged:: 1.6
With both ``start-after`` and ``lines`` in use, the first line as per With both ``start-after`` and ``lines`` in use, the first line as per
``start-after`` is considered to be with line number ``1`` for ``lines``. ``start-after`` is considered to be with line number ``1`` for ``lines``.