mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-08-11 05:24:49 -05:00
Merge branch 'stable'
This commit is contained in:
@@ -222,6 +222,9 @@ General configuration
|
||||
* app.add_directive
|
||||
* app.add_role
|
||||
* app.add_generic_role
|
||||
* app.add_source_parser
|
||||
* image.data_uri
|
||||
* image.nonlocal_uri
|
||||
* ref.term
|
||||
* ref.ref
|
||||
* ref.numref
|
||||
|
||||
+12
-6
@@ -33,11 +33,14 @@ There are two kinds of test blocks:
|
||||
* *code-output-style* blocks consist of an ordinary piece of Python code, and
|
||||
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
|
||||
``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.
|
||||
|
||||
Directives
|
||||
----------
|
||||
|
||||
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]
|
||||
|
||||
@@ -171,7 +174,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!
|
||||
|
||||
|
||||
There are also these config values for customizing the doctest extension:
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
The doctest extension uses the following configuration values:
|
||||
|
||||
.. confval:: doctest_default_flags
|
||||
|
||||
|
||||
+2
-2
@@ -51,7 +51,7 @@ The third form provides your theme path dynamically to Sphinx if the
|
||||
called ``sphinx_themes`` in your setup.py file and write a ``get_path`` function
|
||||
that has to return the directory with themes in it::
|
||||
|
||||
// in your 'setup.py'
|
||||
# 'setup.py'
|
||||
|
||||
setup(
|
||||
...
|
||||
@@ -63,7 +63,7 @@ that has to return the directory with themes in it::
|
||||
...
|
||||
)
|
||||
|
||||
// in 'your_package.py'
|
||||
# 'your_package.py'
|
||||
|
||||
from os import path
|
||||
package_dir = path.abspath(path.dirname(__file__))
|
||||
|
||||
Reference in New Issue
Block a user