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

Loosen doc/requirements.txt #2700

Closed
wants to merge 1 commit into from
Closed

Loosen doc/requirements.txt #2700

wants to merge 1 commit into from

Conversation

EwoutH
Copy link
Contributor

@EwoutH EwoutH commented Nov 15, 2021

Loosen the package requirements in doc/requirements.txt.

  • docutils<0.18 allows docutils 0.17.1 and maybe a future 0.17.2
  • sphinx and sphinx_bootstrap_theme now only have minimal versions

This enables the docs to be build with Python 3.10.

Loosen the package requirements in doc/requirements.txt.
 - docutils<0.18 allows docutils 0.17.1 and maybe a future 0.17.2
 - sphinx and sphinx_bootstrap_theme now only have minimal versions
@mwaskom
Copy link
Owner

mwaskom commented Nov 15, 2021

Hi, is there a problem you had that motivated this change? The Sphinx and sphinx-bootstrap versions were pinned for a reason, I believe.

@EwoutH
Copy link
Contributor Author

EwoutH commented Nov 15, 2021

Thanks for the very quick reply! I'm trying to build the docs with Python 3.10, to revert #2685. To do that, at least sphinx v4.3.0 is needed.

On my branch, the docs build with the loosend requirements passes with both Python 3.9 and 3.10.

@mwaskom
Copy link
Owner

mwaskom commented Nov 15, 2021

Yes but, if I remember correctly, they look wrong with more recent sphinxes.

@EwoutH
Copy link
Contributor Author

EwoutH commented Nov 15, 2021

I did a test run in which I generated all the docs and uploaded them as artifact. When viewing them in a .rst viewer they look fine.

In #2393 the doc/requirements.txt was updated, pinning sphinx and sphinx_bootstrap_theme at seemingly arbitrary version, and removing the comment that is messed up the css. Might that issue be fixed in later versions?

@mwaskom
Copy link
Owner

mwaskom commented Nov 16, 2021

I think you're right that whatever specific issue I had in mind is no longer a problem. But still, that doesn't answer whether is there a reason for this update? Pinning the versions prevents builds from suddenly breaking and causing problems, or from having something upstream cause a change in outputs and missing it at the version when it happened, making it harder to debug.

Also, for some reason, your artifact build is missing plots on the introduction page and for the first three sections of the tutorial.

@mwaskom
Copy link
Owner

mwaskom commented Nov 26, 2021

Thanks @EwoutH but I don't think it's the right time to update these versions since there apparently is some issue preventing a full build of the docs. I'd like to move over to the pydata theme anyway (#2093) and don't think it's worth it to spend a lot of time making the current version of the docs work on newer versions of sphinx. I did pull your tweak to the docutils version requirement into #2704 (odd that docutils doesn't use .0 for micro releases; I didn't even realize they did them).

@mwaskom mwaskom closed this Nov 26, 2021
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