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.

Sign up for GitHub

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

Jump to bottom

Allow recent Sphinx versions #1306

Closed
wants to merge 1 commit into from
Closed

Allow recent Sphinx versions #1306

wants to merge 1 commit into from

Conversation

andrey-utkin
Copy link

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.

Allow recent Sphinx versions
3485606 
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-io
Copy link

codecov-io commented Nov 3, 2017 •
edited
Loading

Codecov Report

Merging #1306 into develop will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

andrey-utkin pushed a commit to andrey-utkin/gentoo that referenced this pull request Nov 3, 2017
dev-python/botocore: allow recent Sphinx versions
6d8f9e2 
Bump upper boundary of allowed version of Shpinx to 1.7 in new,
non-stabilized botocore ebuilds.

Dependency on Sphinx has versions range. Declaration of this range comes
from requirements-docs.txt in botocore sources, but that file hasn't
been updated since 2015. Latest Sphinx, version 1.6.5, builds botocore
docs successfully.

Sphinx versions range bump has been suggested to botocore maintainers,
but there's nothing preventing newer Sphinx from working on already
released botocore versions.

Link: boto/botocore#1306

Package-Manager: Portage-2.3.12, Repoman-2.3.3
gentoo-bot pushed a commit to gentoo/gentoo that referenced this pull request Nov 5, 2017
dev-python/botocore: allow recent Sphinx versions
8ae430d 
Bump upper boundary of allowed version of Shpinx to 1.7 in new,
non-stabilized botocore ebuilds.

Dependency on Sphinx has versions range. Declaration of this range comes
from requirements-docs.txt in botocore sources, but that file hasn't
been updated since 2015. Latest Sphinx, version 1.6.5, builds botocore
docs successfully.

Sphinx versions range bump has been suggested to botocore maintainers,
but there's nothing preventing newer Sphinx from working on already
released botocore versions.

Link: boto/botocore#1306
Acked-by: Alex Brandt <alunduil@gentoo.org>
Package-Manager: Portage-2.3.12, Repoman-2.3.3
@stealthycoin
Copy link
Contributor

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.

@andrey-utkin
Copy link
Author

@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.

@tim-finnigan
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@andrey-utkin @codecov-io @stealthycoin @tim-finnigan @kdaily