Anonymous avatar Anonymous committed 054f3f2

Put doctests in "default" by default and update docs for doctest extension.

Comments (0)

Files changed (2)

doc/ext/doctest.rst

    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
    ``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.
 
 .. 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::
 
       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::
 

sphinx/ext/doctest.py

             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
     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)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.