Skip to content

Migrate docs hosting from Read the Docs to GitHub Pages#45

Merged
lesnik512 merged 10 commits into
mainfrom
feat/mkdocs-github-pages
Jun 9, 2026
Merged

Migrate docs hosting from Read the Docs to GitHub Pages#45
lesnik512 merged 10 commits into
mainfrom
feat/mkdocs-github-pages

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Summary

  • Adds .github/workflows/docs.yml mirroring modern-di's pattern: mkdocs gh-deploy --force on push to main (paths-filtered), concurrency-serialized, contents: write.
  • Adds just docs-deploy target driving the deploy via uvx --with-requirements docs/requirements.txt mkdocs gh-deploy --force.
  • Adds docs/CNAME and mkdocs.yml site_url for the custom domain faststream-outbox.modern-python.org.
  • Deletes .readthedocs.yaml; updates the four readthedocs.io links in README.md to modern-python.org equivalents.
  • Bumps action pins in ci.yml and publish.yml to the same baseline the new docs.yml uses (checkout@v6, setup-just@v4, setup-uv@v8.2.0).

Spec: planning/specs/2026-06-09-mkdocs-github-pages-design.md

Out-of-repo steps after merge

  1. DNS: CNAME faststream-outbox.modern-python.orgmodern-python.github.io.
  2. After the first workflow run creates gh-pages, set Settings → Pages → Source = gh-pages branch, / root.
  3. Tick "Enforce HTTPS" once the cert provisions (~5 min).
  4. Archive the faststream-outbox project on readthedocs.io.

Test plan

  • PR CI is green (ci.yml lint + pytest jobs run with bumped pins).
  • After merge, the Deploy Docs workflow runs and creates the gh-pages branch.
  • https://faststream-outbox.modern-python.org/ returns the docs site once DNS + Pages settings are in place.
  • All four README.md links resolve to working pages on the new domain.
  • A subsequent push to main touching docs/ re-deploys.

🤖 Generated with Claude Code

lesnik512 and others added 10 commits June 9, 2026 14:33
Spec for mirroring modern-di's docs.yml workflow: new GH Actions deploy
on push to main, custom domain faststream-outbox.modern-python.org via
docs/CNAME, mkdocs.yml site_url, RTD config + readthedocs.io README
links removed. Action pin bumps for ci.yml / publish.yml come along so
all three workflows land on the same checkout@v6 / setup-just@v4 /
setup-uv@v8.2.0 baseline.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Eight bite-sized tasks, one commit per task, plus pre-flight and final
verification. Mirrors spec 2026-06-09-mkdocs-github-pages-design.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Triggers on push to main when docs/, mkdocs.yml, or this workflow
change. Concurrency group serializes deploys; contents:write needed
for gh-pages branch push; fetch-depth: 0 needed for gh-deploy history.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Docs now deploy from .github/workflows/docs.yml. RTD project will be
archived in the RTD UI after the new URL is live (out-of-repo step).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replaces readthedocs.io/en/latest/<path>/ with
modern-python.org/<path>/ for the three deep links (relay, dlq,
how-it-works) and the bare-domain Documentation header link.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
actions/checkout v4 -> v6
extractions/setup-just v2 -> v4
astral-sh/setup-uv v3 -> v8.2.0

Matches the baseline modern-di already runs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Matches the pins applied to ci.yml and docs.yml in this branch.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@lesnik512 lesnik512 self-assigned this Jun 9, 2026
@lesnik512 lesnik512 merged commit 51d0b12 into main Jun 9, 2026
3 checks passed
@lesnik512 lesnik512 deleted the feat/mkdocs-github-pages branch June 9, 2026 12:28
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