address Read the Docs changes #117
Merged
Conversation
This file contains 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
|
RtD docs aren't super clear about what format the canonical URL is in the env var. I added some print statements for the last build, and got: I think the only way to get a link to whatever the current docs currently are, for example "/en/3.0.x/..." but later "/en/3.1.x/..." is to use the |
Read the Docs no longer injects this information during the build. It also required a new build of each old version whenever a new version was released, which is not practical. Instead, use JavaScript to determine the banner when viewed. Query PyPI for the list of versions, and compare the docs version. Use CSS for scroll offset.
davidism
force-pushed
the
docs-rtd-changes
branch
from
5801da3
to
fa2ccb2
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 no longer injects extra information into
conf.pyduring build.The base canonical URL is available in the
READTHEDOCS_CANONICAL_URLenv var.The versions are only available through the API. I was already planning to redo our version banners, because they're not convenient right now. It currently requires a new build of each old version when a new version is released, which is not practical. (For example, all old versions will no longer build due to the RtD changes.)