Skip to main content

Doctest plugin for pytest with support for Sphinx-specific doctest-directives

Project description

See Build Status on Travis CI See Build Status on AppVeyor

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 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”


  • pytest
  • enum34 (for python2.7)


You can install “pytest-sphinx” via pip from PyPI:

$ pip install pytest-sphinx



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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pytest-sphinx, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size pytest-sphinx-0.3.1.tar.gz (8.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page