Doctest plugin for pytest with support for Sphinx-specific doctest-directives
Project description
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)
Requirements
pytest
enum34 (for python2.7)
Installation
You can install “pytest-sphinx” via pip from PyPI:
$ pip install pytest-sphinx
Usage
See doctest-sphinx.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pytest_sphinx-0.1.2-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 821e98bdc61372429fce8f894d1a402ff3d957d1cd8f4bc92f89ff4d78d3f01d |
|
MD5 | 036450a4b5793b5f38627113368cd364 |
|
BLAKE2b-256 | b1c917210cb5090b5b6f6a569f71015069c8edad05023a138a160be7278d455a |