pytest-docs 0.0.2b0

Documentation tool for pytest

Documentation tool for pytest

---

This pytest plugin was generated with Cookiecutter along with @hackebrot’s cookiecutter-pytest-plugin template.

Features

Create documentation of your tests. Current supported formats:

• Markdown

• reStrcutured text

Why not sphinx?

(More accurately, why not sphinx-autodoc?) Sphinx is an amazing tool that I use and used in other project. To use its autodoc plugin, it need the documented plugin to be importable by the python interperter. Pytest test collection and invocation uses a completely separate mechanism. If you believe that it somehow possible to use sphinx to create pytest documentation, please do not hesitate to contact me.

Requirements

• Python 3.4, 3.5, 3.6 or 3.7

• Pytest >= 3.5.0

Installation

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

$ pip install pytest-docs

Usage

Use --docs [PATH] to create the documentation.

Use --doc-type to select the type (currently supports md and rst)

Note: pytest-docs uses the pytest collection mechanism, so your documentation will be generated according the the usual collection commands used to run the tests.

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 MIT license, “pytest-docs” is free and open source software

Issues

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