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

Pin exact version of pydata-sphinx-theme #84

Closed
wants to merge 1 commit into from
Closed

Conversation

dstansby
Copy link
Member

Since the goal of this sphinx theme is to maintain a consistent look across multiple documentation builds, it makes sense to pin the exact version of pydata-sphinx-theme to prevent different doc bulids being done with different versions and looking different.

This also allows us to bump this pin only when we've checked there aren't any issues with the next pydata-sphinx-theme version (e.g. see #80 for recent issues).

@timhoffm
Copy link
Member

timhoffm commented Jan 23, 2024

I’m not convinced pinning is really helpful here. We don’t want to spent explicit time on checking that new versions of pydata-Sphinx-theme is still working for us. I think the devdocs can serve as an experimental build for the current version of the documentation environment. it’s more likely that will find problems if the docs are ready available. Only when we see problems, we should temporarily pin the theme. Pragmatically, if we don’t encounter any problems in the devdocs there either are none or they are small enough so that they are bearable in release builds.

@dstansby
Copy link
Member Author

Makes sense - given that we have spotted problems (#80) I think it still makes sense to put this pin in (I want to rebuild some other MPL docs, https://matplotlib.org/cycler/ and https://matplotlib.org/cheatsheets/ to have a consistent theme with matplotlib.org) and then remove it when #80 is fixed?

@dstansby
Copy link
Member Author

dstansby commented Mar 7, 2024

Given https://github.com/matplotlib/matplotlib/pull/27658/files has now been merged, I don't think we need to do this pinning any more so I'll close this.

@dstansby dstansby closed this Mar 7, 2024
@QuLogic QuLogic deleted the pin-pydata branch May 8, 2024 20:03
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