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.
This Pytest plugin was generated with Cookiecutter along with @hackebrot's Cookiecutter-pytest-plugin template.
- support for
testcode
andtestoutput
directives - support for
testsetup
andtestcleanup
is planned (pull-requests welcome) - support for parsing global optionflags (
doctest_optionflags
) frompytest.ini
- support for
:options:
intestoutput
- pytest
- enum34 (for python2.7)
You can install "pytest-sphinx" via pip from PyPI:
$ pip install pytest-sphinx
- See doctest-sphinx.
- Run pytest with the --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.