diff options
| author | Bernat Gabor <gaborjbernat@gmail.com> | 2018-10-07 13:38:18 +0100 |
|---|---|---|
| committer | Bernát Gábor <gaborjbernat@gmail.com> | 2018-10-07 22:32:42 +0100 |
| commit | fc5ca1984e3adccfbb63cfdea499cd3689ddcacf (patch) | |
| tree | ee7cca7283bd1bb399833cb7fba79917bd479119 /docs/example | |
| parent | dfecdfdb105c0531ac7c6c72275818baabb3a0fb (diff) | |
| download | tox-git-fc5ca1984e3adccfbb63cfdea499cd3689ddcacf.tar.gz | |
remove sphinx as present in its own section
Diffstat (limited to 'docs/example')
| -rw-r--r-- | docs/example/general.rst | 31 |
1 files changed, 0 insertions, 31 deletions
diff --git a/docs/example/general.rst b/docs/example/general.rst index 7083ff2f..613e5987 100644 --- a/docs/example/general.rst +++ b/docs/example/general.rst @@ -39,37 +39,6 @@ syntax: [testenv] commands = nosetests {posargs:--with-coverage} -.. _`sphinx checks`: - -Integrating "sphinx" documentation checks ----------------------------------------------- - -In a ``testenv`` environment you can specify any command and -thus you can easily integrate sphinx_ documentation integrity during -a tox test run. Here is an example ``tox.ini`` configuration: - -.. code-block:: ini - - [testenv:docs] - changedir = doc - deps = sphinx - commands = sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html - -This will create a dedicated ``docs`` virtual environment and install -the ``sphinx`` dependency which itself will install the ``sphinx-build`` tool -which you can then use as a test command. Note that sphinx output is redirected -to the virtualenv environment temporary directory to prevent sphinx -from caching results between runs. - -You can now call: - -.. code-block:: shell - - tox - -which will make the sphinx tests part of your test run. - - .. _`TOXENV`: Selecting one or more environments to run tests against |
