This is a fork from the Read the Docs Sphinx Theme.
This theme is used as a dependency for building Cilium's Documentation. The build system references it in Cilium's Documentation/requirements.txt, generated from Cilium's Documentation/requirements-min/requirements.txt.
These files reference the commit and branch from the current repository that are used for building Cilium's documentation.
The cilium/main branch in this repository is the primary branch.
To update the theme:
- Clone this repository
- Implement your changes on top of the current branch in use
- Commit and push the changes to your own repository
- Reference your repository and branch in
Documentation/requirements.txtin Cilium - Build the documentation locally or create a PR in Cilium to get the preview from the CI
Once your changes are ready, you can create a PR in the current repo (and if
the version of this theme gets updated, create the equivalent PR in Cilium to
update Documentation/requirements-min/requirements.txt and regenerate
Documentation/requirements.txt).