summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-11-21 04:15:54 -0800
committerSteve Piercy <web@stevepiercy.com>2016-11-21 04:15:54 -0800
commit60ff6ab9d2c1fcbbe97a39e8e9535d167605d6de (patch)
treee4bb7645c2c7b85972863754cf970e971e62ea38 /docs
parent90db2bc106822be4ba3ca92a51a932f17d5ce4f7 (diff)
downloadpyramid-60ff6ab9d2c1fcbbe97a39e8e9535d167605d6de.tar.gz
pyramid-60ff6ab9d2c1fcbbe97a39e8e9535d167605d6de.tar.bz2
pyramid-60ff6ab9d2c1fcbbe97a39e8e9535d167605d6de.zip
add literalinclude options
Diffstat (limited to 'docs')
-rw-r--r--docs/style-guide.rst61
1 files changed, 52 insertions, 9 deletions
diff --git a/docs/style-guide.rst b/docs/style-guide.rst
index c30b199a6..7868f97e7 100644
--- a/docs/style-guide.rst
+++ b/docs/style-guide.rst
@@ -468,22 +468,65 @@ The above code renders as follows. Note that ``lineno-start`` and ``emphasize-li
:lineno-start: 11
:emphasize-lines: 1,6-7,9-
-Additional options include the following.
+``literalinclude`` also supports including only parts of a file. If it is a Python module, you can select a class, function, or method to include using the ``pyobject`` option.
+
+.. code-block:: rst
+
+ .. literalinclude:: narr/helloworld.py
+ :language: python
+ :pyobject: hello_world
+
+The above code renders as follows. It returns the function ``hello_world`` in the source file.
.. literalinclude:: narr/helloworld.py
- :lines: 1-3
- :emphasize-lines: 3
- :lineno-match:
:language: python
+ :pyobject: hello_world
+
+Alternatively, you can specify exactly which lines to include by giving a ``lines`` option.
+
+.. code-block:: rst
+
+ .. literalinclude:: narr/helloworld.py
+ :language: python
+ :lines: 6-7
+
+The above code renders as follows.
.. literalinclude:: narr/helloworld.py
- :linenos:
- :pyobject: hello_world
+ :language: python
+ :lines: 6-7
+
+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.
-.. literalinclude:: quick_tour/sqla_demo/sqla_demo/models/mymodel.py
+.. code-block:: rst
+
+ .. literalinclude:: narr/helloworld.py
+ :language: python
+ :start-after: from pyramid.response import Response
+ :end-before: if __name__ == '__main__':
+
+The above code renders as follows.
+
+.. literalinclude:: narr/helloworld.py
+ :language: python
+ :start-after: from pyramid.response import Response
+ :end-before: if __name__ == '__main__':
+
+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.
+
+.. code-block:: rst
+
+ .. literalinclude:: narr/helloworld.py
+ :language: python
+ :lines: 6-7
+ :lineno-match:
+
+The above code renders as follows.
+
+.. literalinclude:: narr/helloworld.py
:language: python
- :start-after: Start Sphinx Include
- :end-before: End Sphinx Include
+ :lines: 6-7
+ :lineno-match:
.. _style-guide-inline-code: