Skip to content

horta/pytest-sphinx

 
 

Repository files navigation

pytest-sphinx

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.

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

Requirements

  • pytest
  • enum34 (for python2.7)

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.

About

sphinx doctest plugin for pytest

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%