pytest-sphinx

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.

Features

• support for the doctest directive
• support for testcode and testoutput directives
• support for testsetup and testcleanup is planned (pull-requests welcome)
• support for parsing global optionflags (doctest_optionflags) from pytest.ini
• support for :options: in testoutput
• support for :skipif: in testcode and in testoutput
• :hide: is ignored by "pytest-sphinx"

Requirements

• pytest

Installation

You can install "pytest-sphinx" via pip from PyPI:

$ pip install pytest-sphinx

Usage

• See doctest-sphinx. Have a look at the examples in doctest-examples.
• Run pytest with the --doctest-modules flag.

Contributing

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.

License

Distributed under the terms of the BSD-3 license, "pytest-sphinx" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.