.. image:: https://github.com/thisch/pytest-sphinx/workflows/Test/badge.svg :target: https://github.com/thisch/pytest-sphinx/actions :alt: Action Status
A doctest plugin for pytest, which understands the sphinx-specific
directives from doctest-sphinx_. Those sphinx-specific directives can be
used in rst files as well as in docstrings of python modules.
doctest directivetestcode and testoutput directivestestsetup and testcleanup is planned (pull-requests welcome)doctest_optionflags) from
pytest.ini:options: in testoutput:skipif: in testcode and in testoutput:hide: is ignored by "pytest-sphinx"You can install "pytest-sphinx" via pip from PyPI::
$ pip install pytest-sphinxdoctest-sphinx. Have a look at the examples in doctest-examples.--doctest-modules flag.Contributions are very welcome. Tests can be run with tox_, please ensure
the coverage at least stays the same before you submit a pull request.
Distributed under the terms of the BSD-3_ license, "pytest-sphinx" is free and open source software
If you encounter any problems, please file an issue_ along with a detailed description.
.. doctest-sphinx: http://www.sphinx-doc.org/en/stable/ext/doctest.html
.. doctest-examples: https://github.com/sphinx-doc/sphinx/blob/master/tests/roots/test-ext-doctest/doctest.txt
.. @hackebrot: https://github.com/hackebrot
.. MIT: http://opensource.org/licenses/MIT
.. BSD-3: http://opensource.org/licenses/BSD-3-Clause
.. GNU GPL v3.0: http://www.gnu.org/licenses/gpl-3.0.txt
.. Apache Software License 2.0: http://www.apache.org/licenses/LICENSE-2.0
.. file an issue: https://github.com/thisch/pytest-sphinx/issues
.. pytest: https://github.com/pytest-dev/pytest
.. tox: https://tox.readthedocs.io/en/latest/
.. pip: https://pypi.python.org/pypi/pip/
.. PyPI: https://pypi.python.org/pypi