Conversation
…al address Read the Docs serves both sites from custom domains now (sphinx-mounts.useblocks.com, codelinks.useblocks.com) and passes every build the address it serves that version from in READTHEDOCS_CANONICAL_URL. Sphinx writes a <link rel="canonical"> into each page from html_baseurl, which neither conf.py set, so no page declared its address. Set it from the variable. Outside Read the Docs the variable is unset, html_baseurl is empty (Sphinx's default), and the output is unchanged.
github-actions
Bot
added
pkg: sphinx-mounts
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2004 +/- ##
==========================================
+ Coverage 91.69% 91.76% +0.06%
==========================================
Files 129 129
Lines 18155 18111 -44
==========================================
- Hits 16648 16619 -29
+ Misses 1507 1492 -15
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
codelinks.useblocks.com points at Read the Docs now, which builds the docs from this repository. The bullet no longer says "nothing changes for a reader of that URL": links into the old, unversioned GitHub Pages site (/basics/installation.html) 404 until the project gets a redirect or the single-version URL scheme.
Documentation build overview
|
This branch has not been deployed
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.
Read the Docs now serves both docs sites from custom domains, https://sphinx-mounts.useblocks.com and https://codelinks.useblocks.com, and passes every build the address it serves that version from in
READTHEDOCS_CANONICAL_URL. Sphinx writes a<link rel="canonical">into each page fromhtml_baseurl, which neitherconf.pyset, so no page declared its canonical address. This sets it from the variable in both.Outside Read the Docs the variable is unset and
html_baseurlis empty, which is Sphinx's default, so local builds and CI's docs jobs produce the same output as before.Verification
uv run poe docs-mountsanduv run poe docs-codelinkspass (-nW), with the variable set and without it.READTHEDOCS_CANONICAL_URL=https://sphinx-mounts.useblocks.com/en/latest/, all 10 content pages carry it, e.g.<link rel="canonical" href="https://sphinx-mounts.useblocks.com/en/latest/motivation.html">. The 11th HTML file in the output is a template that gets copied into_static.READTHEDOCS_CANONICAL_URL=https://codelinks.useblocks.com/en/latest/, all 18 content pages carry it. Two kinds of page carry none, and this PR doesn't change them: the traced-source pages sphinx-codelinks generates, and sphinx-needs'permalink.html. Both render from their own templates.uv run poe lintpasses.No changelog entry: nothing in either package changes, only the HTML of their docs sites.