Skip to content

Configure Read the Docs hosting and update documentation links - #16

Merged
florian6973 merged 1 commit into
mainfrom
codex/read-the-docs
Nov 8, 2026
Merged

florian6973 merged 1 commit into
mainfrom
codex/read-the-docs

Conversation

@florian6973

Copy link
Copy Markdown
Collaborator

Add Read the Docs hosting configuration for the existing MkDocs Material site, using Python 3.12 and the existing uv docs dependency group. Update the README badge, catalogue link and package documentation URL; use READTHEDOCS_CANONICAL_URL with a local-build fallback.

Document project import, main/latest version setup and the GitHub Pages transition. Existing Pages publishing remains enabled until the first successful Read the Docs deployment; the guide explains replacing it with redirects while retaining GitHub Actions checks. Template documentation stays at its existing URL.

Validation:

  • Locked dependency installation on Python 3.12 succeeds without lock changes.
  • 24 catalogue tests, offline registry validation, Ruff lint/format checks pass.
  • Strict MkDocs builds pass with and without READTHEDOCS_CANONICAL_URL; generated canonical URLs checked in both cases.
  • Read the Docs YAML parsed and expected settings checked; git diff --check passes.

The hosted Read the Docs build has not been run. Import/connect the repository with the meds-algorithm slug and verify its first build before completing the Pages cutover. No release or runtime changes.

@florian6973
florian6973 merged commit ea33532 into main Nov 8, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant