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.

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

fix: Disallow Sphinx v5.1.0 to avoid 'exception: pop from an empty deque' #1925

Merged
merged 2 commits into from Jul 26, 2022

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Jul 26, 2022

Description

  • Disallow Sphinx v5.1.0 as it introduces an deque error that can be caused by sphinx.ext.napoleon:
Extension error (sphinx.ext.napoleon):
Handler <function _process_docstring at 0x7f43e8361a20> for event 'autodoc-process-docstring' threw an exception (exception: pop from an empty deque)

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
* Disallow Sphinx v5.1.0 as it introduces an deque error that can be
  caused by sphinx.ext.napoleon:
> Extension error (sphinx.ext.napoleon):
> Handler <function _process_docstring at 0x7f43e8361a20> for event 'autodoc-process-docstring'
> threw an exception (exception: pop from an empty deque)
   - This was fixed rapidly in https://github.com/sphinx-doc/sphinx/pull/10709 and
     so will not be a problem in Sphinx v5.1.1+.

…que'

* Disallow Sphinx v5.1.0 as it introduces an deque error that can be
  caused by sphinx.ext.napoleon:
> Extension error (sphinx.ext.napoleon):
> Handler <function _process_docstring at 0x7f43e8361a20> for event 'autodoc-process-docstring'
> threw an exception (exception: pop from an empty deque)
   - This was fixed rapidly in https://github.com/sphinx-doc/sphinx PR 10709 and
     so will not be a problem in Sphinx v5.1.1+.
@matthewfeickert matthewfeickert added docs Documentation related fix A bug fix labels Jul 26, 2022
@matthewfeickert matthewfeickert self-assigned this Jul 26, 2022
@matthewfeickert matthewfeickert added this to In progress in v0.7.0 via automation Jul 26, 2022
@matthewfeickert
Copy link
Member Author

Other CI is failing for known reasons (Issue #1918) and so this is only going to fix the docs CI.

@matthewfeickert
Copy link
Member Author

As this is only to get the docs CI passing, I'm going to approve and merge this myself. As always, PRs approved by a single core dev can be reverted as needed by the rest of the dev team.

@matthewfeickert matthewfeickert merged commit c722766 into master Jul 26, 2022
v0.7.0 automation moved this from In progress to Done Jul 26, 2022
@matthewfeickert matthewfeickert deleted the fix/limit-sphinx-until-patch branch July 26, 2022 07:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related fix A bug fix
Projects
Development

Successfully merging this pull request may close these issues.

None yet

1 participant