Metadata-Version: 2.1
Name: pytest-docs
Version: 0.0.3
Summary: Documentation tool for pytest
Home-page: https://github.com/liiight/pytest_docs
License: UNKNOWN
Author: orcarmi
Author-email: ocarmi@proofpoint.com
Requires-Python: >=3.3,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Testing
Requires-Dist: pytest
Description-Content-Type: text/x-rst

===========
pytest-docs
===========

Documentation tool for pytest

.. image:: https://img.shields.io/pypi/v/pytest-docs.svg
    :target: https://pypi.org/project/pytest-docs
    :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/pytest-docs.svg
    :target: https://pypi.org/project/pytest-docs
    :alt: Python versions

.. image:: https://travis-ci.org/liiight/pytest_docs.svg?branch=master
    :target: https://travis-ci.org/liiight/pytest-docs
    :alt: See Build Status on Travis CI

----

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.

.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
.. _`@hackebrot`: https://github.com/hackebrot
.. _`MIT`: http://opensource.org/licenses/MIT
.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt
.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. _`file an issue`: https://github.com/liiight/pytest-docs/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`tox`: https://tox.readthedocs.io/en/latest/
.. _`pip`: https://pypi.org/project/pip/
.. _`PyPI`: https://pypi.org/project

