=================== cookiecutter-sphinx

A cookiecutter_ template for a Sphinx extension_ within the sphinxcontrib_ namespace.

This template focuses on setting up the scaffolding of the project: for information on actually writing your plugin, refer to the Sphinx documentation_.

Features

• pbr_ for simple packaging.
• pytest_ for testing.
• tox_ for automation of test runners and other stuff.

Other stuff we include:

• Travis CI_ support for unit tests (using the tox-travis_ plugin).
• mypy_ integration for type annotations.
• yapf_-based automatic Python code formatting.

Usage

Install cookiecutter::

pip install cookiecutter

Generate a Python package::

cookiecutter https://github.com/sphinx-contrib/cookiecutter.git

Next steps:

• Create a GitHub repo for your project and push your code.

• Read CONTRIBUTING <CONTRIBUTING.rst>__ for information on submitting the package to the sphinx-contrib organization.

License

Apache License, Version 2.0 <LICENSE>__

.. _cookiecutter: https://github.com/audreyr/cookiecutter/ .. _Sphinx extension: http://www.sphinx-doc.org/en/stable/extdev/ .. _sphinxcontrib: https://github.com/sphinx-contrib .. _Sphinx documentation: http://www.sphinx-doc.org/en/master/ .. _pbr: https://docs.openstack.org/pbr/latest/ .. _pytest: https://docs.pytest.org/en/latest/ .. _tox: https://tox.readthedocs.io/en/latest/ .. _Travis CI: https://travis-ci.org/ .. _tox-travis: https://github.com/tox-dev/tox-travis .. _mypy: http://mypy.readthedocs.io/en/latest/ .. _yapf: https://github.com/google/yapf