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

Also remove # doctest: directives in presentation output.

Browse Source
This commit is contained in:
Georg Brandl 2008-03-22 21:21:28 +00:00
parent b82b162729
commit 7111855bab
3 changed files with 23 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -5,7 +5,8 @@ Changes in trunk
placed selectable, and default to ``'default'``. placed selectable, and default to ``'default'``.
* sphinx.ext.doctest: Replace <BLANKLINE> in doctest blocks by * sphinx.ext.doctest: Replace <BLANKLINE> in doctest blocks by
real blank lines for presentation output. real blank lines for presentation output, and remove doctest
options given inline.
* sphinx.environment: Move doctest_blocks out of block_quotes to * sphinx.environment: Move doctest_blocks out of block_quotes to
support indented doctest blocks. support indented doctest blocks.

12
doc/ext/doctest.rst
View File

@ -69,6 +69,14 @@ names.
signal a blank line in the expected output. The ``<BLANKLINE>`` is removed signal a blank line in the expected output. The ``<BLANKLINE>`` is removed
when building presentation output (HTML, LaTeX etc.). when building presentation output (HTML, LaTeX etc.).
Also, you can give inline doctest options, like in doctest::
>>> datetime.date.now() # doctest: +SKIP
datetime.date(2008, 1, 1)
They will be respected when the test is run, but stripped from presentation
output.
.. directive:: .. testcode:: [group] .. directive:: .. testcode:: [group]
@ -178,4 +186,6 @@ There are also these config values for customizing the doctest extension:
special directive. special directive.
Note though that you can't have blank lines in reST doctest blocks. They 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. will be interpreted as one block ending and another one starting. Also,
removal of ``<BLANKLINE>`` and ``# doctest:`` options only works in
:dir:`doctest` blocks.

15
sphinx/ext/doctest.py
View File

@ -25,7 +25,7 @@ from sphinx.builder import Builder
from sphinx.util.console import bold from sphinx.util.console import bold
blankline_re = re.compile(r'^\s*<BLANKLINE>', re.MULTILINE) blankline_re = re.compile(r'^\s*<BLANKLINE>', re.MULTILINE)
doctestopt_re = re.compile(r'#\s*doctest:.+$', re.MULTILINE)
# set up the necessary directives # set up the necessary directives
@ -35,10 +35,15 @@ def test_directive(name, arguments, options, content, lineno,
# so that our builder recognizes them, and the other builders are happy. # so that our builder recognizes them, and the other builders are happy.
code = '\n'.join(content) code = '\n'.join(content)
test = None test = None
if name == 'doctest' and '<BLANKLINE>' in code: if name == 'doctest':
# convert <BLANKLINE>s to ordinary blank lines for presentation if '<BLANKLINE>' in code:
test = code # convert <BLANKLINE>s to ordinary blank lines for presentation
code = blankline_re.sub('', code) test = code
code = blankline_re.sub('', code)
if doctestopt_re.search(code):
if not test:
test = code
code = doctestopt_re.sub('', code)
nodetype = nodes.literal_block nodetype = nodes.literal_block
if name == 'testsetup' or 'hide' in options: if name == 'testsetup' or 'hide' in options:
nodetype = nodes.comment nodetype = nodes.comment