[Python-checkins] r61745 - in doctools/trunk: doc/ext/doctest.rst sphinx/ext/doctest.py
georg.brandl
python-checkins at python.org
Sat Mar 22 14:07:22 CET 2008
Author: georg.brandl
Date: Sat Mar 22 14:07:22 2008
New Revision: 61745
Modified:
doctools/trunk/doc/ext/doctest.rst
doctools/trunk/sphinx/ext/doctest.py
Log:
Put doctests in "default" by default and update docs for doctest extension.
Modified: doctools/trunk/doc/ext/doctest.rst
==============================================================================
--- doctools/trunk/doc/ext/doctest.rst (original)
+++ doctools/trunk/doc/ext/doctest.rst Sat Mar 22 14:07:22 2008
@@ -44,6 +44,7 @@
A setup code block. This code is not shown in the output for other builders,
but executed before the doctests of the group(s) it belongs to.
+
.. directive:: .. doctest:: [group]
A doctest-style code block. You can use standard :mod:`doctest` flags for
@@ -54,10 +55,27 @@
``DONT_ACCEPT_TRUE_FOR_1`` (by default, doctest accepts "True" in the output
where "1" is given -- this is a relic of pre-Python 2.2 times).
+ This directive supports two options:
+
+ * ``hide``, a flag option, hides the doctest block in other builders. By
+ default it is shown as a highlighted doctest block.
+
+ * ``options``, a string option, can be used to give a comma-separated list of
+ doctest flags that apply to each example in the tests. (You still can give
+ explicit flags per example, with doctest comments, but they will show up in
+ other builders too.)
+
+
.. directive:: .. testcode:: [group]
A code block for a code-output-style test.
+ This directive supports one option:
+
+ * ``hide``, a flag option, hides the code block in other builders. By
+ default it is shown as a highlighted code block.
+
+
.. directive:: .. testoutput:: [group]
The corresponding output for the last :dir:`testcode` block.
@@ -121,8 +139,9 @@
.. confval:: doctest_test_doctest_blocks
- If ``True`` (the default), standard reST doctest blocks will be tested too.
- They will be assigned to a group named ``doctest_block``.
+ If this is a nonempty string (the default is ``'default'``), standard reST
+ doctest blocks will be tested too. They will be assigned to the group name
+ given.
reST doctest blocks are simply doctests put into a paragraph of their own,
like so::
@@ -134,6 +153,10 @@
Some more documentation text.
+ (Note that no special ``::`` is needed to introduce the block; docutils
+ recognizes it from the leading ``>>>``. Also, no additional indentation is
+ necessary, though it doesn't hurt.)
+
If this value is true, the above snippet is interpreted by the doctest
builder exactly like the following::
Modified: doctools/trunk/sphinx/ext/doctest.py
==============================================================================
--- doctools/trunk/sphinx/ext/doctest.py (original)
+++ doctools/trunk/sphinx/ext/doctest.py Sat Mar 22 14:07:22 2008
@@ -218,7 +218,7 @@
code = TestCode(node.astext(),
type=node.get('testnodetype', 'doctest'),
lineno=node.line, options=node.get('options'))
- node_groups = node.get('groups', ['doctest_block'])
+ node_groups = node.get('groups', ['default'])
if '*' in node_groups:
add_to_all_groups.append(code)
continue
@@ -305,4 +305,4 @@
app.add_builder(DocTestBuilder)
# this config value adds to sys.path
app.add_config_value('doctest_path', [], False)
- app.add_config_value('doctest_test_doctest_blocks', True, False)
+ app.add_config_value('doctest_test_doctest_blocks', 'default', False)
More information about the Python-checkins
mailing list