Skip to content

Commit fc5ca19

Browse files
committed
remove sphinx as present in its own section
1 parent dfecdfd commit fc5ca19

File tree

1 file changed

+0
-31
lines changed

1 file changed

+0
-31
lines changed

docs/example/general.rst

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -39,37 +39,6 @@ syntax:
3939
[testenv]
4040
commands = nosetests {posargs:--with-coverage}
4141
42-
.. _`sphinx checks`:
43-
44-
Integrating "sphinx" documentation checks
45-
----------------------------------------------
46-
47-
In a ``testenv`` environment you can specify any command and
48-
thus you can easily integrate sphinx_ documentation integrity during
49-
a tox test run. Here is an example ``tox.ini`` configuration:
50-
51-
.. code-block:: ini
52-
53-
[testenv:docs]
54-
changedir = doc
55-
deps = sphinx
56-
commands = sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
57-
58-
This will create a dedicated ``docs`` virtual environment and install
59-
the ``sphinx`` dependency which itself will install the ``sphinx-build`` tool
60-
which you can then use as a test command. Note that sphinx output is redirected
61-
to the virtualenv environment temporary directory to prevent sphinx
62-
from caching results between runs.
63-
64-
You can now call:
65-
66-
.. code-block:: shell
67-
68-
tox
69-
70-
which will make the sphinx tests part of your test run.
71-
72-
7342
.. _`TOXENV`:
7443

7544
Selecting one or more environments to run tests against

0 commit comments

Comments
 (0)