-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Description:
Our documentation is already generated using Sphinx and deployed via GitHub Pages. We now want to also publish it on Read the Docs to take advantage of:
- Automatic builds on push
- Versioned documentation per branch/tag
- Improved discoverability and hosting stability
Acceptance Criteria:
- Create a Read the Docs project linked to our repository.
- Ensure
conf.py
andrequirements.txt
contain all dependencies needed for the build. - Add a
.readthedocs.yaml
file in the repository root to configure the build. - Verify the documentation builds successfully on Read the Docs.
- Confirm the public Read the Docs URL is working and in sync with our GitHub Pages version.
- Enable versioned builds to match our tagged releases.
Usefull resources
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Type
Projects
Status
Backlog