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

Split doctest extension docs into sections

Browse Source 
At the moment the docs have no sections at all. This commit adds
sections "Directives" and "Configuration" to facilitate navigation.
Also, it removes the outdated line about the number of directives
provided by the extension (there’s now 5 of them).
This commit is contained in:
nevimov 2016-05-02 01:29:15 +07:00
parent 06e2928ef0
commit 0960f0d9f2
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/ext/doctest.rst
View File

@ -33,11 +33,14 @@ There are two kinds of test blocks:
* *code-output-style* blocks consist of an ordinary piece of Python code, and * *code-output-style* blocks consist of an ordinary piece of Python code, and
optionally, a piece of output for that code. optionally, a piece of output for that code.
The doctest extension provides four directives. The *group* argument is
interpreted as follows: if it is empty, the block is assigned to the group named Directives
``default``. If it is ``*``, the block is assigned to all groups (including the ----------
``default`` group). Otherwise, it must be a comma-separated list of group
names. The *group* argument below is interpreted as follows: if it is empty, the block
is assigned to the group named ``default``. If it is ``*``, the block is
assigned to all groups (including the ``default`` group). Otherwise, it must be
a comma-separated list of group names.
.. rst:directive:: .. testsetup:: [group] .. rst:directive:: .. testsetup:: [group]
@ -174,7 +177,10 @@ The following is an example for the usage of the directives. The test via
This parrot wouldn't voom if you put 3000 volts through it! This parrot wouldn't voom if you put 3000 volts through it!
There are also these config values for customizing the doctest extension: Configuration
-------------
The doctest extension uses the following configuration values:
.. confval:: doctest_path .. confval:: doctest_path