Skip to content

sphinx-contrib/cookiecutter

Repository files navigation

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

Releases

No releases published

Packages

No packages published

Languages