Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: generate internal links dynamically #228

Merged
merged 4 commits into from
Aug 26, 2024
Merged

Conversation

aryarm
Copy link
Member

@aryarm aryarm commented Aug 24, 2024

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 the latest version refers to whatever is currently on the master branch.

Usually, if a user is browsing the latest version of the docs, all of the internal links will also point to the latest version. And vice versa for the stable 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.

@aryarm aryarm marked this pull request as ready for review August 26, 2024 16:54
@gymreklab gymreklab self-requested a review August 26, 2024 18:28
Copy link
Contributor

@gymreklab gymreklab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for doing this! this does move all the docs out of the main readme which is what people see on the github landing page, but points them to the appropriate place in readthedocs so should be fine

@aryarm aryarm merged commit 9402042 into master Aug 26, 2024
12 checks passed
@aryarm aryarm deleted the docs/dynamic-links branch August 26, 2024 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants