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

[Maintenance] Lift sphinx pin to <6 #258

Closed

Conversation

psobolewskiPhD
Copy link
Member

@psobolewskiPhD psobolewskiPhD commented Oct 31, 2023

References and relevant issues

Closes #259

Depends on napari/napari-sphinx-theme#133
See also #256 (comment)

Description

Lifts the sphinx pin to <6 for compatibility with sphinx_tags

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 31, 2023
@psobolewskiPhD psobolewskiPhD added maintenance CI, dependencies, and other maintenance and removed documentation Improvements or additions to documentation labels Oct 31, 2023
@psobolewskiPhD psobolewskiPhD added this to the 0.5.0 milestone Oct 31, 2023
@Czaki
Copy link
Contributor

Czaki commented Oct 31, 2023

If we have a pin in napari-sphinx-theme them we may just remove the pin here?

Copy link
Member

@melissawm melissawm left a comment

Choose a reason for hiding this comment

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

I see this is passing so +1!

@psobolewskiPhD
Copy link
Member Author

Yeah it builds, but I thought it would fail because the theme pin isn't lifted yet.
@melissawm what's interesting is this in the circle CI logs:

Successfully installed beautifulsoup4-4.12.2 colorama-0.4.6 fastjsonschema-2.18.1 greenlet-3.0.1 imageio-ffmpeg-0.4.9 jupyter-cache-0.6.1 livereload-2.6.3 mdit-py-plugins-0.3.5 myst-nb-0.17.2 myst-parser-0.18.1 napari-sphinx-theme-0.1.1 nbclient-0.7.4 nbformat-5.9.2 soupsieve-2.5 sphinx-5.3.0 sphinx-autobuild-2021.3.14 sphinx-copybutton-0.5.2 sphinx-design-0.5.0 sphinx-external-toc-0.3.1 sphinx-favicon-1.0.1 sphinx-gallery-0.14.0 sphinx-tabs-3.4.0 sphinx-tags-0.3.0 sphinx_autodoc_typehints-1.12.0 sqlalchemy-2.0.22 tabulate-0.9.0

Sphinx 5.3 even though napari-sphinx-theme pins <5 as well.
Still, solves the issue with sphinx-tags 0.3.0...

@Czaki
Copy link
Contributor

Czaki commented Oct 31, 2023

sphinx-tags declares as sphinx>4 compatybile:

Requires-Dist: sphinx>4

@melissawm
Copy link
Member

Yes but we use the newest pydata-sphinx-theme there, which requires sphinx>5, so maybe we're just not seeing the issue there because the tests require sphinx>5. I should probably bump those requirements there too.

@melissawm
Copy link
Member

This is also passing for me locally so I think we should merge and plan for a new napari-sphinx-theme release soon, whatever the path we choose to follow.

@Czaki
Copy link
Contributor

Czaki commented Oct 31, 2023

Yes but we use the newest pydata-sphinx-theme there

where we use pydata-sphinx-theme? I do not find it in dependencies.

Copy link
Contributor

@Czaki Czaki left a comment

Choose a reason for hiding this comment

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

The sphinx constraints could be inherited from napari-sphinx-theme

@@ -1,4 +1,4 @@
sphinx<5
sphinx<6
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
sphinx<6
sphinx

@@ -1,4 +1,4 @@
sphinx<5
sphinx<6
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
sphinx<6
sphinx

@melissawm
Copy link
Member

Yes but we use the newest pydata-sphinx-theme there

where we use pydata-sphinx-theme? I do not find it in dependencies.

Sorry, in sphinx-tags. So it goes like this:

  • sphinx-tags is built and tested with sphinx>5
  • napari docs requires sphinx<5 and the newest sphinx-tags
  • Docs fail to build.

One option is to pin sphinx-tags<0.3; another option is to do this PR, which solves the docs build. In addition, we would also want to update the constraints files over at napari/napari to all list sphinx<6

@Czaki
Copy link
Contributor

Czaki commented Oct 31, 2023

One option is to pin sphinx-tags<0.3; another option is to do this PR

the #260 do this pin

@psobolewskiPhD
Copy link
Member Author

This came up at the docs workgroup.
With release of 0.3.1 of sphinx tags (which has the Sphinx>5.1 req) and yank the 0.3.0 one, our Sphinx<5 protects us from failing builds for the time being. When the new theme is released--after 0.4.19 release--we'll be changing the pins in the followup PR to this repo:
#267

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance CI, dependencies, and other maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs build is failing
3 participants