docs: serve the documentation from gpjax.quantclimate.com - #740
Open
thomaspinder wants to merge 2 commits into
Open
docs: serve the documentation from gpjax.quantclimate.com#740thomaspinder wants to merge 2 commits into
thomaspinder wants to merge 2 commits into
Conversation
Repoints the published docs at docs.quantclimate.com. GitHub Pages serves exactly one custom domain per site, so this is a move rather than an addition. - docs/CNAME and html_baseurl, which between them drive the Pages custom domain, the sitemap, the canonical link, og:url and the absolute og:image URL. All four were verified in a clean build. - The Documentation URL in pyproject.toml and the 15 documentation links in README.md. Deliberately NOT changed: the three https://jaxgaussianprocesses.com/contact/ links in README.md, GOVERNANCE.md and CODE_OF_CONDUCT.md. That is the separate marketing site, not the docs host. The 87 sphinx-reredirects entries are unaffected: their targets are written site-absolute, so they resolve against whatever domain serves them. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QXcSotTJspF11tgaJfrXrZ
|
📖 Docs preview: https://pr-740--endearing-crepe-c2d5fe.netlify.app Smoke render — the expensive notebooks run with reduced budgets, so |
Renames the target host from docs.quantclimate.com to gpjax.quantclimate.com, matching the <project>.quantclimate.com convention that impulso will also use. Adds legacy-docs-redirect/, the complete contents of the Netlify site that keeps docs.jaxgaussianprocesses.com alive as a permanent redirect. GitHub Pages serves one custom domain per site and cannot answer for both hosts, so without this every published link to the old domain 404s -- the JOSS paper, the PyPI project page, search results and third-party citations. The rule is a bare wildcard carrying `:splat` through unchanged. That is deliberate: old MkDocs-era URLs are still in circulation and the new site ships 87 sphinx-reredirects stubs keyed on exactly those paths, so preserving the path lets the chain complete as legacy host -> new host -> stub -> final page. Rewriting paths in the redirect would break it. Deployed by hand, never by CI, and documented as such -- `--prod` belongs in that one manual command and must never reach the PR preview step, which uses `--alias` precisely so a pull request cannot overwrite a production deploy. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QXcSotTJspF11tgaJfrXrZ
thomaspinder
changed the title
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
1 participant
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.
Repoints the published documentation at
gpjax.quantclimate.com, matching the<project>.quantclimate.comconvention that Impulso will also adopt.GitHub Pages serves exactly one custom domain per site, so this is a move, not an addition — hence the redirect bundle below.
What changed
docs/CNAMEhtml_extra_path; the hostname Pages is told to servedocs/conf.py(html_baseurl)og:urland the absoluteog:imageURLpyproject.tomlDocumentationproject URL shown on PyPIREADME.mdlegacy-docs-redirect/Verified in a clean build: deployed
CNAME,<link rel="canonical">,og:url,og:imageand every<loc>insitemap.xmlcarry the new domain, and no reference to any previous docs host survives indocs/_build/html.Deliberately not changed: the three
https://jaxgaussianprocesses.com/contact/links inREADME.md,GOVERNANCE.mdandCODE_OF_CONDUCT.md— that is the separate marketing site, not the docs host.Not losing the existing traffic
docs.jaxgaussianprocesses.comis where the JOSS paper, PyPI, search results and every third-party citation point.legacy-docs-redirect/_redirectsis a bare wildcard:The path is carried through unchanged on purpose. Old MkDocs-era URLs are still in circulation, and the new site ships 87
sphinx-reredirectsstubs keyed on exactly those paths, so the chain completes:/_examples/classification/on the old host → same path on the new host → reredirect stub →/examples/classification.htmlRewriting paths in the redirect would break that. URL fragments are never sent to the server and are reattached by the browser, so
#laplace-approximationdeep links survive too.It is deployed by hand, once, and never by CI.
--prodbelongs in that one manual command and must never reach the PR preview step, which uses--aliasspecifically so a pull request cannot overwrite a production deploy. PR previews are unaffected — they are alias deploys atpr-<n>--<site>.netlify.app.Deployment notes — order matters
Merging this alone will not move the site, and merging before DNS is ready would take the docs offline: once a custom domain is set, Pages 301-redirects
thomaspinder.github.io/GPJaxto it, and that URL is currently the only working copy of the new docs.gpjaxrecord with a CNAME tothomaspinder.github.iogpjax.quantclimate.comhtml_baseurllegacy-docs-redirect/to the Netlify site serving the old docs host🤖 Generated with Claude Code
https://claude.ai/code/session_01QXcSotTJspF11tgaJfrXrZ