docs: generate internal links dynamically #228
Merged
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.
readthedocs hosts different versions of our documentation. The bottom/left corner of their site allows you to select and change between the versions:
The
stable
version of our docs refers to the latest version that has been released, while thelatest
version refers to whatever is currently on themaster
branch.Usually, if a user is browsing the
latest
version of the docs, all of the internal links will also point to thelatest
version. And vice versa for thestable
version. But unfortunately, many of the pages of our docs have direct links to an internal URL rather than dynamically generated links.This PR fixes that so that all internal links are generated dynamically. The drawback of this is that the links will no longer work when the docs are previewd on GitHub directly, but I think we usually prefer to preview the docs on readthedocs anyway.