1. Benoit Boissinot
  2. tonfa/sphinx

Commits

Georg Brandl  committed 08173f5

Document new literalinclude options.

  • Participants
  • Parent commits 6f05edb
  • Branches default

Comments (0)

Files changed (1)

File doc/markup/code.rst

View file
    This would only include the code lines belonging to the ``start()`` method in
    the ``Timer`` class within the file.
 
+   Alternately, you can specify exactly which lines to include by giving a
+   ``lines`` option::
+
+      .. literalinclude:: example.py
+         :lines: 1,3,5-10,20-
+
+   This includes the lines 1, 3, 5 to 10 and lines 20 to the last line.
+
+   Another way to control which part of the file is included is to use the
+   ``start-after`` and ``end-before`` options (or only one of them).  If
+   ``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.
+
    .. versionadded:: 0.4.3
       The ``encoding`` option.
    .. versionadded:: 0.6
-      The ``pyobject`` option.
+      The ``pyobject``, ``lines``, ``start-after`` and ``end-before`` options.
 
 
 .. rubric:: Footnotes