Changed readme links to relative #551
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
|
I just realised that this means links on GitHub might not work quite correctly. I'll leave the PR open for review for a time being though. |
|
Yeah, I'd like the GitHub page to keep working. If there's a way to make them both work, I'm all for it. Please file an issue? |
bbayles
requested changes
Sep 3, 2021
# Conflicts: # README.rst # docs/conf.py
|
got into a bit of a fight with GitHub workflow. sorry, not something I could have fixed locally. turns out that 1) when creating files with python they need to be opened |
bbayles
reviewed
Sep 4, 2021
bbayles
reviewed
Sep 4, 2021
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.
While looking at issue #541, I've noticed that locally built documentation has hyperlinks to the online one. While this works when documentation is online, it's not ideal for offline build. Moreover, when browsing legacy documentation online, the links take one to the
stabledocumentation and, arguably, they shouldn't. This is a minor issue, so I thought I'll just submit a PR and see what happens.Sphinx's linkcheck is struggling a bit with the relative links (probably because of the order in which the pages are generated. see this issue), so I've selectivelly silenced them.
I've also taken the liberty to make the .rst table a bit less wide.