click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications
MIT License
212 stars 57 forks source link

Sphinx version on requirements.txt #54

Closed williamjamir closed 4 years ago

williamjamir commented 4 years ago

I noticed that in your requirement.txt you are limiting the sphinx version to 1.5>, <2.3

Are there any known issue or something more serious for this limitation being added?

Otherwise, I would suggest modifying to "sphinx > 1.5", allowing new versions of sphinx to be used as normally.

My motivation for this question is because I'm updating the recipe for conda (https://github.com/conda-forge/sphinx-click-feedstock/pull/6)

@stephenfin do you agree with the modification?

stephenfin commented 4 years ago

Go for it. Maybe limit to <3.0 though since there might be breaking changes in that version

williamjamir commented 4 years ago

Thanks for the quick answer =)

I've changed the conda package, to include this restriction (sphinx>=1.5,<3.0) and opened a PR to keep the requirements.txt in sync with the conda package ;)