https://github.com/sphinx-contrib/cookiecutter
A cookiecutter template for a Sphinx extension
https://github.com/sphinx-contrib/cookiecutter
sphinx sphinx-extension sphinxcontrib
Last synced: 7 days ago
JSON representation
A cookiecutter template for a Sphinx extension
- Host: GitHub
- URL: https://github.com/sphinx-contrib/cookiecutter
- Owner: sphinx-contrib
- License: bsd-2-clause
- Created: 2017-09-27T21:02:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-11T12:29:57.000Z (over 1 year ago)
- Last Synced: 2025-04-07T15:01:30.341Z (about 1 month ago)
- Topics: sphinx, sphinx-extension, sphinxcontrib
- Language: Python
- Homepage:
- Size: 14.6 KB
- Stars: 25
- Watchers: 3
- Forks: 10
- Open Issues: 9
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
===================
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 `__ for information on submitting the
package to the `sphinx-contrib` organization.
License
-------
`Apache License, Version 2.0 `__
.. _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