Skip to content

Export Sphinx-Generated Documentation to Read the Docs #56

@BaptisteLacroix

Description

@BaptisteLacroix

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 and requirements.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

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions