Migrate docs hosting from GitHub Pages to ReadTheDocs#347
Merged
chrisguidry merged 1 commit intomainfrom Feb 20, 2026
Merged
Conversation
The docs CI workflow fails on fork PRs because GitHub restricts the `GITHUB_TOKEN` to read-only, and the `marocchino/sticky-pull-request-comment` step can't post. Rather than patching around that, this switches docs hosting to ReadTheDocs Community, which has built-in PR preview builds that work for fork PRs automatically. Changes: - Add `.readthedocs.yaml` with custom build commands for Zensical - Add `site_url: https://docket.lol/` to `mkdocs.yml` - Simplify `docs.yml` to a build-check-only workflow (no publish job, no sticky comment, minimal permissions) - Update all doc URLs in README to `docket.lol` After merge: import project on readthedocs.org, set up Porkbun ALIAS record for `docket.lol`, configure custom domain in RTD settings, and delete the `github-pages` environment from the repo. Co-Authored-By: Claude Opus 4.6 <[email protected]>
chrisguidry
added a commit
that referenced
this pull request
Feb 20, 2026
Follow-up to #347 — RTD serves docs under `/en/latest/` with multi-version mode. Root URLs redirect fine, but subpage links (getting-started, api-reference, testing) need the prefix to resolve directly. Co-Authored-By: Claude Opus 4.6 <[email protected]>
chrisguidry
added a commit
that referenced
this pull request
Feb 20, 2026
Follow-up to #347 — RTD serves docs under `/en/latest/` with multi-version mode. Root URLs redirect fine, but subpage links (getting-started, api-reference, testing) need the prefix to resolve directly. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.6 <[email protected]>
chrisguidry
added a commit
that referenced
this pull request
Feb 20, 2026
Docs moved to ReadTheDocs in #347. This redirects old GitHub Pages URLs to the new domain, preserving subpaths via 404.html. Co-Authored-By: Claude Opus 4.6 <[email protected]>
chrisguidry
added a commit
that referenced
this pull request
Feb 20, 2026
Follow-up to #347 — now that docs are on ReadTheDocs, update the project URLs so PyPI links to docket.lol instead of the GitHub repo. Also adds separate Documentation and Repository entries. Co-Authored-By: Claude Opus 4.6 <[email protected]>
chrisguidry
added a commit
that referenced
this pull request
Feb 20, 2026
Follow-up to #347 — now that docs are on ReadTheDocs, update the project URLs so PyPI links to docket.lol instead of the GitHub repo. Also adds separate Documentation and Repository entries. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.6 <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #347 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 99 99
Lines 3098 3098
Branches 27 27
=========================================
Hits 3098 3098
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs CI workflow fails on fork PRs because GitHub restricts the
GITHUB_TOKENto read-only, and themarocchino/sticky-pull-request-commentstep can't post. Rather than patching around that, this switches docs
hosting to ReadTheDocs Community, which has built-in PR preview builds
that work for fork PRs automatically.
Custom domain:
docket.lol(apex, via Porkbun ALIAS record toreadthedocs.io)Changes:
.readthedocs.yamlwith custom build commands for Zensicalsite_url: https://docket.lol/tomkdocs.ymldocs.ymlto a build-check-only workflow (no publish job,no sticky comment, minimal permissions)
docket.lolAfter merge: import project on readthedocs.org, set up Porkbun ALIAS
record for
docket.lol, configure custom domain in RTD settings, anddelete the
github-pagesenvironment from the repo.🤖 Generated with Claude Code