Skip to main content

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

Project description

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.

Features

  • 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

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.

Project details


Download files

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

Source Distribution

pytest-sphinx-0.4.0.tar.gz (8.8 kB view hashes)

Uploaded source

Built Distribution

pytest_sphinx-0.4.0-py3-none-any.whl (9.1 kB view hashes)

Uploaded py3

Supported by

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