botocore
botocore copied to clipboard
Allow recent Sphinx versions
Bump upper boundary of allowed version of Shpinx to 1.7.
requirements-docs.txt (which hasn't been updated since 2015) declares that Sphinx of version older than 1.3 should be used. However, Sphinx 1.6.5 builds docs successfully.
Codecov Report
Merging #1306 into develop will not change coverage. The diff coverage is
n/a
.
@@ Coverage Diff @@
## develop #1306 +/- ##
========================================
Coverage 98.07% 98.07%
========================================
Files 45 45
Lines 7421 7421
========================================
Hits 7278 7278
Misses 143 143
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact)
,ø = not affected
,? = missing data
Powered by Codecov. Last update 593393f...3485606. Read the comment docs.
What is the use case for this? I would be hesitant to upgrade a dependency without a compelling reason to do so. I don't see any reason in the changelog between 1.3 and 1.7 that would compel me to upgrade.
@stealthycoin you don't have to upgrade if you don't want to. The point is to declare that it is supposed to work with recent Sphinx versions as well as with e.g. 1.3. For example, previously botocore Gentoo Linux package would require you to install stale 1.2.x version of Sphinx if you want to have botocore docs built and installed. If a person has recent version of Sphinx installed for whatever reason, this requires the user to downgrade Sphinx on their system, which is pretty unpleasant and is totally not necessary from technical perspective, yet this is what upstream metadata dictates.
In Gentoo Linux botocore (and boto3) packages, I have already unbound required Sphinx version from what upstream requirements.txt dictates, but I hope you get the point why such an update in requiremnents.txt would be nice to have.
Thanks for creating this PR. However it is now outdated due to recent changes to the documentation. Here are the current requirements: https://github.com/boto/botocore/blob/develop/requirements-docs.txt. Please create a new GitHub issue for any issues related to this going forward.