This is a cookiecutter template for a Python package with Documentation hosted on GitHub Pages.
Features:
- Python 3.x package with setuptools
- 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
andgh-pages
- Read the Docs theme with sphinx_rtd_theme
- Render jupyter notebooks with nbsphinx
- Automatic API Reference from code docstrings with autodoc
- Continuous Integration with GitHub Actions
- Run tests on
main
forpush
andpull_request
events- Upload code coverage to codecov
- Publish to PyPI on
release
event - Build documentation on
push
andpull_request
events ongh-pages
branch - Lint with flake8 - using also flake8-rst-docstrings to catch RST formatting errors - on all
push
andpull_request
events tomain
.
- Run tests on
- MIT License