giocaizzi / cookiecutter-python-ghpages

Cookiecutter template for a Python package with Documentation hosted on GitHub Pages.

cookiecutter-python-ghpages

This is a cookiecutter template for a Python package with Documentation hosted on GitHub Pages.

Features:

• Python 3.x package with setuptools
  • Formatting with black
  • Linting with flake8
• Testing with pytest
  • Code coverage with pytest-cov
• Documentation with Sphinx
  • Automatic API Reference from code docstrings with autodoc
    • Custom API Reference with jinja2
  • Optimized for GitHub Pages, with separate branches for main and gh-pages
  • Read the Docs theme with sphinx_rtd_theme
  • Render jupyter notebooks with nbsphinx
• Continuous Integration with GitHub Actions
  • Run tests on main for push and pull_request events
    • Upload code coverage to codecov
  • Publish to PyPI on release event
  • Build documentation on push and pull_request events on gh-pages branch
  • Lint with flake8 - using also flake8-rst-docstrings to catch RST formatting errors - on all push and pull_request events to main.
• MIT License