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

docs: Unrestrict Sphinx from v3.0.X releases #933

Merged
merged 4 commits into from
Jul 9, 2020
Merged

docs: Unrestrict Sphinx from v3.0.X releases #933

merged 4 commits into from
Jul 9, 2020

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Jul 9, 2020 •
edited
Loading

Description

Resolves #897

Avoid the regressions caused by Sphinx v3.1.0 and v3.1.1 by requiring Sphinx v3.1.2 or later.

Huge thanks goes out to @tk0miya 🙇 who did some amazing work to make sure that Sphinx would still support libraries that are using pyhf's style of syntax (c.f. Sphinx Issue 7844).

ReadTheDocs build: https://pyhf.readthedocs.io/en/docs-unrestrict-sphinx

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Require Sphinx release v3.1.2 or later
   - Avoid regressions in Sphinx v3.1.0 and v3.1.1

@matthewfeickert matthewfeickert added the docs Documentation related label Jul 9, 2020
@matthewfeickert matthewfeickert self-assigned this Jul 9, 2020
@codecov
Copy link

codecov bot commented Jul 9, 2020 •
edited
Loading

Codecov Report

Merging #933 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #933   +/-   ##
=======================================
  Coverage   96.30%   96.30%           
=======================================
  Files          56       56           
  Lines        3191     3191           
  Branches      438      438           
=======================================
  Hits         3073     3073           
  Misses         75       75           
  Partials       43       43
Flag Coverage Δ
#unittests 96.30% <ø> (ø)

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 c898e05...e4ca223. Read the comment docs.

@matthewfeickert matthewfeickert added the fix A bug fix label Jul 9, 2020
@kratsg kratsg merged commit 3aa8a76 into master Jul 9, 2020
@kratsg kratsg deleted the docs/unrestrict-Sphinx branch July 9, 2020 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kratsg kratsg kratsg approved these changes

@lukasheinrich lukasheinrich Awaiting requested review from lukasheinrich

Assignees

@matthewfeickert matthewfeickert

Labels
docs Documentation related fix A bug fix
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs build broken with Sphinx v3.1.1
2 participants
@matthewfeickert @kratsg