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

5.1.0 Extension error (sphinx.ext.napoleon): (exception: pop from an empty deque) #10705

Closed
Zlopez opened this issue Jul 25, 2022 · 6 comments
Closed

5.1.0 Extension error (sphinx.ext.napoleon): (exception: pop from an empty deque) #10705

Zlopez opened this issue Jul 25, 2022 · 6 comments
Labels
extensions:napoleon type:bug

Comments

@Zlopez
Copy link

Zlopez commented Jul 25, 2022

Describe the bug

When updating sphinx from 5.0.2 to 5.1.0 following error started happening in sphinx build of Anitya project:

Extension error (sphinx.ext.napoleon):
Handler <function _process_docstring at 0x7fb4a98f60e0> for event 'autodoc-process-docstring' threw an exception (exception: pop from an empty deque)

How to Reproduce

$ git clone https://github.com/fedora-infra/anitya
$ git checkout dependabot/pip/sphinx-5.1.0
$ pip install -r requirements.txt -r test_requirements.txt
$ pip install .
$ cd docs
$ sphinx-build -W -b html  .  _build/html

Expected behavior

Documentation is build

Your project

https://github.com/fedora-infra/anitya

Screenshots

No response

OS

Linux

Python version

3.10.5

Sphinx version

5.1.0

Sphinx extensions

sphinx.ext.napoleon

Extra tools

No response

Additional context

No response
@Zlopez Zlopez mentioned this issue Jul 25, 2022
Closed
manthey added a commit to girder/large_image that referenced this issue Jul 25, 2022
@manthey
Sphinx 5.1.0 ahs a bug that causes the docs not to build.
0146ea8 
See sphinx-doc/sphinx#10705
@mwichmann
Copy link

The always helpful "me too" (from https://github.com/SCons/scons). Identical exception msg.

@vfazio
Copy link

vfazio commented Jul 25, 2022 •
edited

Same, our project is now running into this.

[app] emitting event: 'build-finished'(ExtensionError("Handler <function _process_docstring at 0x7f6c5942cd30> for event 'autodoc-process-

Traceback (most recent call last):
  File "/home/vfazio/.pyenv/versions/3.10.4/envs/xtf-3.10.4/lib/python3.10/site-packages/sphinx/events.py", line 94, in emit
    results.append(listener.handler(self.app, *args))
  File "/home/vfazio/.pyenv/versions/3.10.4/envs/xtf-3.10.4/lib/python3.10/site-packages/sphinx/ext/napoleon/__init__.py", line 385, in _process_docstring
    docstring = NumpyDocstring(result_lines, app.config, app, what, name,
  File "/home/vfazio/.pyenv/versions/3.10.4/envs/xtf-3.10.4/lib/python3.10/site-packages/sphinx/ext/napoleon/docstring.py", line 1148, in __init__
    super().__init__(docstring, config, app, what, name, obj, options)
  File "/home/vfazio/.pyenv/versions/3.10.4/envs/xtf-3.10.4/lib/python3.10/site-packages/sphinx/ext/napoleon/docstring.py", line 214, in __init__
    self._parse()
  File "/home/vfazio/.pyenv/versions/3.10.4/envs/xtf-3.10.4/lib/python3.10/site-packages/sphinx/ext/napoleon/docstring.py", line 595, in _parse
    res = self._parse_attribute_docstring()
  File "/home/vfazio/.pyenv/versions/3.10.4/envs/xtf-3.10.4/lib/python3.10/site-packages/sphinx/ext/napoleon/docstring.py", line 627, in _parse_attribute_docstring
    _type, _desc = self._consume_inline_attribute()
  File "/home/vfazio/.pyenv/versions/3.10.4/envs/xtf-3.10.4/lib/python3.10/site-packages/sphinx/ext/napoleon/docstring.py", line 304, in _consume_inline_attribute
    line = self._lines.popleft()
IndexError: pop from an empty deque

effigies added a commit to bids-standard/pybids that referenced this issue Jul 25, 2022
@effigies
MNT: Pin sphinx <5.1
f4e2a98 
Pending sphinx-doc/sphinx#10705
@vfazio
Copy link

vfazio commented Jul 25, 2022

probably dupe of #10701 caused by #9856

@manthey manthey mentioned this issue Jul 25, 2022
Merged
@anntzer anntzer mentioned this issue Jul 25, 2022
Merged
@IanMagnusson IanMagnusson mentioned this issue Jul 25, 2022
Closed
@AdamGleave AdamGleave mentioned this issue Jul 25, 2022
Closed
@rocco8773 rocco8773 mentioned this issue Jul 25, 2022
Merged
@AA-Turner
Copy link
Member

Duplicates #10701

@AA-Turner AA-Turner closed this as not planned Won't fix, can't repro, duplicate, stale Jul 25, 2022
@AA-Turner AA-Turner mentioned this issue Jul 25, 2022
Closed
@AA-Turner
Copy link
Member

I plan to release 5.1.1 tomorrow, details in #10710. Please test the 5.1.x branch as soon as possible, as set out in #10710.

A

@freakboy3742 freakboy3742 mentioned this issue Jul 26, 2022
Merged
4 tasks
garth-wells added a commit to FEniCS/dolfinx that referenced this issue Jul 26, 2022
@garth-wells
Downgrade Sphinx version.
0183be3 
See sphinx-doc/sphinx#10705.
garth-wells added a commit to FEniCS/dolfinx that referenced this issue Jul 26, 2022
@jorgensd @garth-wells
Remove non-existent function from C++ docs (#2290)
80123e8 
* Function does no longer exist.

* Downgrade Sphinx version.

See sphinx-doc/sphinx#10705.

* Fix command

Co-authored-by: Garth N. Wells <gnw20@cam.ac.uk>
@Padarn Padarn mentioned this issue Jul 26, 2022
Merged
dweindl added a commit to PEtab-dev/libpetab-python that referenced this issue Jul 26, 2022
@dweindl
Sphinx !=5.1.0
84d4e5f 
sphinx-doc/sphinx#10705
@obackhouse obackhouse mentioned this issue Jul 26, 2022
Merged
@anoopks12
Copy link

Working fine in Sphinx 5.1.1

@obackhouse obackhouse mentioned this issue Jul 27, 2022
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions:napoleon type:bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@mwichmann @vfazio @Zlopez @AA-Turner @anoopks12