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

Clean up number of versions on readthedocs #2415

Closed
dstansby opened this issue Oct 19, 2024 · 6 comments
Closed

Clean up number of versions on readthedocs #2415

dstansby opened this issue Oct 19, 2024 · 6 comments
Labels
documentation Improvements to the documentation

Comments

@dstansby
Copy link
Contributor

There's a lot of doc versions available on readthedocs, and it would be nice to slim these down. I think a good start would be to just keep the last version of every 2.x release (e.g., drop 2.3.0, 2.3.1, and keep 2.3.2). I'm not sure who has permissions on readthedocs, but I would be happy to do this if someone can give me the right permissions.

Screenshot 2024-10-19 at 20 23 15
@dstansby dstansby added the documentation Improvements to the documentation label Oct 19, 2024
@TomAugspurger
Copy link
Contributor

If possible, it'd be nicer to just hide these from the version UI to avoid breaking links pointing to those URLs.

@dstansby
Copy link
Contributor Author

Looks like that's possible by changing the versions to hidden, which hides them from the version switcher and search engines, but keeps the links alive.

@jhamman
Copy link
Member

jhamman commented Oct 19, 2024

I've added everyone on @zarr-developers/python-core-devs (that had an account) as maintainers on read the docs (including @dstansby )

@dstansby
Copy link
Contributor Author

dstansby commented Oct 20, 2024

Thanks! I've:

  • Hidden micro versions as suggested in the top comment
  • Removed the 2.5.0 build, because there's a v2.5.0 build too which I assume is the real docs
  • Removed the latest build, because it was duplicating main (and I think main is a clearer indication that it's a development branch IMO, but happy to switch the other way)
  • Added a support/v2 build so we can see what the dev version of the v2 docs looks like

@jhamman
Copy link
Member

jhamman commented Oct 20, 2024

Removed the latest build, because it was duplicating main (and I think main is a clearer indication that it's a development branch IMO, but happy to switch the other way)

I reverted this change as I know of a few downstream projects that link to latest via intersphinx.

xref: pydata/xarray#9652 (comment)

@dstansby
Copy link
Contributor Author

Woops, thanks for fixing that!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation
Projects
None yet
Development

No branches or pull requests

3 participants