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

Direct readthedocs links to "stable" instead of "latest"? #362

Closed
drbenvincent opened this issue Jun 19, 2024 · 2 comments
Closed

Direct readthedocs links to "stable" instead of "latest"? #362

drbenvincent opened this issue Jun 19, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@drbenvincent
Copy link
Collaborator

In #354, I believe @OriolAbril enabled both "latest" and "stable" versions of the readthedocs. At the moment, the default routes to the latest version, as in if you go to https://causalpy.readthedocs.io/ then you actually end up at https://causalpy.readthedocs.io/en/latest/.

Firstly, I'm assuming that "stable" corresponds to the latest GitHub release, not what is on main, and that "latest" corresponds to what is on main? Is that right?

I'm wondering if it makes sense to automatically route through to "stable" docs. That way, if we merge a PR that provides new documentation about a feature which is not fully available in the latest release, then people won't get confused.

Thoughts welcome. Would this just be a matter of changing a setting in readthedocs web ui?

@drbenvincent drbenvincent added the documentation Improvements or additions to documentation label Jun 19, 2024
@OriolAbril
Copy link
Contributor

Firstly, I'm assuming that "stable" corresponds to the latest GitHub release, not what is on main, and that "latest" corresponds to what is on main? Is that right?

That is right yes. They are both active by default in readthedocs (I am actually not sure if it is possible to turn either off) but as not all repos have releases the default is latest. Once a release is done (aka tags are present) then stable is also generated as the alias to the latest release and can be manually set as default.

Would this just be a matter of changing a setting in readthedocs web ui?

Yes, go to the admin page and there is a dropdown where you can choose the default version.

@drbenvincent
Copy link
Collaborator Author

Done. Now it defaults to "stable"

@drbenvincent drbenvincent added this to the 0.3.1 milestone Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants