search

melissawm / sphinx-tags

A tiny Sphinx extension that implements blog-style tags for documentation.
https://sphinx-tags.readthedocs.io/en/latest/
MIT License
44 stars 11 forks source link

Bump sphinx requirement #78

Closed melissawm closed 10 months ago

melissawm commented 10 months ago

Sphinx<5 creates build errors, but we don't see them here (I think?) because we require sphinx>5 for tests/docs.

psobolewskiPhD commented 10 months ago

It looks like nothing in the dependency tree is pinning back sphinx, so you just get the latest:

Collecting sphinx>4
  Downloading sphinx-7.2.6-py3-none-any.whl.metadata (5.9 kB)

But the from sphinx.util.matching import get_matching_files in 0.3.0 does require sphinx > 5.1

melissawm commented 10 months ago

Exactly, so to make sure this is correctly interpreted downstream it should be pinned to 5.1 at least

psobolewskiPhD commented 10 months ago

Derp, I left that as a review comment that I didn't submit.

psobolewskiPhD commented 10 months ago

Actually, I guess it could be >=5.1 for the greatest flexibility? (>5 not sufficient)

melissawm commented 10 months ago

Thanks @psobolewskiPhD !

JWCook commented 10 months ago

For reference, if someone really needed to use this with an older version of Sphinx, there is a similar matching function in sphinx.util that was there since 1.0, but it was removed in 7.0 (replaced by sphinx.util.matching.get_matching_files()).