summaryrefslogtreecommitdiff
path: root/doc/markup/code.rst
diff options
context:
space:
mode:
authorjfbu <jfbu@free.fr>2017-02-10 14:35:58 +0100
committerjfbu <jfbu@free.fr>2017-02-10 16:55:28 +0100
commita2338e4838223ed9c65397eba57f6fd14e1a062f (patch)
treedc8a426a48bbfa30b61ea8123d3974bead3024bb /doc/markup/code.rst
parent839e924808ad5c8cad8bed567e86eb7cd6970d7c (diff)
downloadsphinx-git-a2338e4838223ed9c65397eba57f6fd14e1a062f.tar.gz
If ``:start-after:`` is used, make ``:lines:`` relative (close: #3412)
Diffstat (limited to 'doc/markup/code.rst')
-rw-r--r--doc/markup/code.rst21
1 files changed, 16 insertions, 5 deletions
diff --git a/doc/markup/code.rst b/doc/markup/code.rst
index ff0f692fa..677deb30f 100644
--- a/doc/markup/code.rst
+++ b/doc/markup/code.rst
@@ -182,13 +182,24 @@ Includes
``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 as a
string option, only lines that precede the first lines containing that string
- are included. If used in combination with ``lines``, make sure the latter
- allows the lines (whose count start at ``1`` at top of file) containing the
- looked-for strings.
+ are included.
+
+ With lines selected this way it is still possible to use ``lines``, the
+ numbers being now interpreted relative to the already selected lines.
+
+ .. versionchanged:: 1.5.3
+ Formerly, ``lines`` still referred to the included file, and it was
+ needed that those lines containing the requested strings were among
+ the allowed ones.
+
+ When lines have been selected in any of the ways described above, the
+ line numbers in ``emphasize-lines`` refer to the selection, with the
+ line count starting at ``1``.
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.
+ display the original line numbers. This can be done using the
+ ``lineno-match`` option, which is however allowed only when the selection
+ consists of contiguous lines.
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