Read the Docs: handle special URLs #200
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
humitos
force-pushed
the
humitos/readthedocs-special-urls
branch
from
10b16ed
to
f4b3537
Compare
humitos
force-pushed
the
humitos/readthedocs-special-urls
branch
from
f4b3537
to
d239688
Compare
Read the Docs serves their static files under special URLs starting with `/_/` that should not be modified by this extension. Otherwise, the flyout and other integrations are broken. This commit checks if the documentation is building on Read the Docs and if the URLs starts with `/_/` and skip the manipulation in that case.
humitos
force-pushed
the
humitos/readthedocs-special-urls
branch
from
d239688
to
4eb39e7
Compare
ericholscher
approved these changes
Jul 12, 2022
| if resource and '://' in otheruri: | ||
| # allow non-local resources given by scheme | ||
| return otheruri | ||
|
|
||
| if READTHEDOCS and otheruri.startswith('/_/'): |
There was a problem hiding this comment.
Do we need to special case RTD here, or should we just not have this run on any URL that is already absolute? I don't fully understand the issue, but generally absolute URL's won't need to change?
There was a problem hiding this comment.
This is a good question. I thought we have already thought about this but I didn't find a test or discussion on the issues.
I think it should be fine to not modify absolute URLs, but I'd prefer to not introduce it right now just in case I'm missing something. So, I created an issue to track, discuss and think more about this before moving forward: #206
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 serves their static files under special URLs starting with
/_/that should not be modified by this extension. Otherwise, the flyout and other
integrations are broken.
This commit checks if the documentation is building on Read the Docs and if the
URLs starts with
/_/and skip the manipulation in that case.404 page showing the flyout properly: https://sphinx-notfound-page--200.org.readthedocs.build/en/200/notfound