A template repository that Sphinx projects can inherit from to ensure tooling consistency
This is a template repository that is intended to be inherited by other template repositories to ensure consistent common tool deployment Sphinx projects.
Additionally, while projects can leverage this template or its content, extending this template is encouraged.
This template is dependent upon Python 3.13 and uv.
It is recommended to install pre-commit as well for per-commit formatting and
linting checks.
make create-dev
make build_project
make serve
Any time that a commit is pushed to GitHub from the main branch, the
build.yml workflow is executed which builds the
project and deploys it to GitHub Pages.
You will need to modify the ReStructured Text directory in the
build.yml from template_sphinx to the name of
your project's directory. You can find the line to modify by searching for
# TODO in the build.yml file. An example of
what to look for is this code block:
- name: Build the site
run: |
./.venv/bin/sphinx-build --write-all template_sphinx build
# TODO: Change `template_sphinx` to the source directoryYou can also deploy the project from the main branch at any time (so long as
the workflow_dispatch event is included in the
build.yml file) from the GitHub Actions page
