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 note about blank lines in doctest blocks.

Browse Source
This commit is contained in:
Georg Brandl 2008-03-22 20:47:27 +00:00
parent b53b3f72e2
commit fa089ae583
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/ext/doctest.rst
View File

@ -157,12 +157,12 @@ There are also these config values for customizing the doctest extension:
recognizes it from the leading ``>>>``. Also, no additional indentation is recognizes it from the leading ``>>>``. Also, no additional indentation is
necessary, though it doesn't hurt.) necessary, though it doesn't hurt.)
If this value is true, the above snippet is interpreted by the doctest If this value is left at its default value, the above snippet is interpreted
builder exactly like the following:: by the doctest builder exactly like the following::
Some documentation text. Some documentation text.
.. doctest:: doctest_block .. doctest::
>>> print 1 >>> print 1
1 1
@ -172,3 +172,6 @@ There are also these config values for customizing the doctest extension:
This feature makes it easy for you to test doctests in docstrings included This feature makes it easy for you to test doctests in docstrings included
with the :mod:`~sphinx.ext.autodoc` extension without marking them up with a with the :mod:`~sphinx.ext.autodoc` extension without marking them up with a
special directive. special directive.
Note though that you can't have blank lines in reST doctest blocks. They
will be interpreted as one block ending and another one starting.