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

Extension error (sphinx.ext.viewcode) with Sphinx 3.5 #8880

Closed
xqt opened this issue Feb 14, 2021 · 3 comments · Fixed by #8888
Closed

Extension error (sphinx.ext.viewcode) with Sphinx 3.5 #8880

xqt opened this issue Feb 14, 2021 · 3 comments · Fixed by #8888
Labels
extensions type:bug
Milestone
3.5.1

Comments

@xqt
Copy link

xqt commented Feb 14, 2021 •
edited
Loading

After deployment of Sphinx 3.5.0 our Pywikibot CI-Tests fails with following exception:

11:12:45 Extension error (sphinx.ext.viewcode):
11:12:45 Handler <function env_purge_doc at 0x7fb96305e6a8> for event 'env-purge-doc' threw an exception (exception: 'bool' object is not iterable)
11:12:46 ERROR: InvocationError for command /src/.tox/doc/bin/sphinx-build -M html ./docs ./docs/_build (exited with code 2)

See

Our bug tracker:
@xqt xqt added the type:bug label Feb 14, 2021
@vytas7 vytas7 mentioned this issue Feb 14, 2021
Merged
@virtuald
Copy link
Contributor

virtuald commented Feb 15, 2021 •
edited
Loading

Looks like modules.items() in viewcode.py: env_purge_doc sometimes returns a bool. Added a print statement:

    x = list(modules.items())
    print(x)

And get

[('wpilib.controller._controller', False)]

@virtuald virtuald mentioned this issue Feb 15, 2021
Merged
@virtuald
Copy link
Contributor

virtuald commented Feb 15, 2021 •
edited
Loading

Pushed a fix at #8888, hopefully they can get a new release out as soon as possible?

@jenshnielsen jenshnielsen mentioned this issue Feb 15, 2021
Closed
@heavelock heavelock mentioned this issue Feb 15, 2021
Open
9 tasks
@ksunden
Copy link
Contributor

ksunden commented Feb 15, 2021

https://github.com/pyqtgraph/pyqtgraph/runs/1900044069

This is affecting pyqtgraph as well.

@mglisse mglisse mentioned this issue Feb 15, 2021
Merged
@jfbu jfbu added this to the 3.5.1 milestone Feb 15, 2021
@ashb ashb mentioned this issue Feb 15, 2021
Closed
potiuk added a commit to potiuk/airflow that referenced this issue Feb 15, 2021
@potiuk
Limits Sphinx to <3.5.0
04fe83a 
Sphinx 3.5.0 released on 14th of Feb introduced a problem in our
doc builds.

It is documented in sphinx-doc/sphinx#8880

Until this problem is solved we are limiting Sphinx.
@potiuk potiuk mentioned this issue Feb 15, 2021
Merged
ashb pushed a commit to apache/airflow that referenced this issue Feb 15, 2021
@potiuk
Limits Sphinx to <3.5.0 (#14238)
da80b69 
Sphinx 3.5.0 released on 14th of Feb introduced a problem in our
doc builds.

It is documented in sphinx-doc/sphinx#8880

Until this problem is solved we are limiting Sphinx.
@bmorris3 bmorris3 mentioned this issue Feb 15, 2021
Merged
@bluetech bluetech mentioned this issue Feb 15, 2021
Merged
tk0miya added a commit to tk0miya/sphinx that referenced this issue Feb 15, 2021
@tk0miya
Fix sphinx-doc#8880: viewcode: ExtensionError is raised on incrementa…
11933a7 
…l build

viewcode causes ExtensionError on incremental build after unparsable
python module found for the document on the past build.

Internally, `False` is stored into `env._viewcode_modules[modname]` for
the modules that failed to parse on the past build.  But `env-purge-doc`
does not handle them.
@tk0miya tk0miya mentioned this issue Feb 15, 2021
Closed
@j9ac9k j9ac9k mentioned this issue Feb 15, 2021
Merged
ddn0 added a commit to ddn0/katana that referenced this issue Feb 15, 2021
@ddn0
Pin sphinx dependency
a97f51e 
Workaround upstream issue: sphinx-doc/sphinx#8880
@ddn0 ddn0 mentioned this issue Feb 15, 2021
Merged
ddn0 added a commit to ddn0/katana that referenced this issue Feb 15, 2021
@ddn0
Pin sphinx dependency
0cb0fb7 
Workaround upstream issue: sphinx-doc/sphinx#8880
@sk1p sk1p mentioned this issue Feb 15, 2021
Merged
5 tasks
uellue added a commit to uellue/LiberTEM that referenced this issue Feb 15, 2021
@uellue
Temporary workaround Sphinx issue
ad99165 
sphinx-doc/sphinx#8880
@Borda Borda mentioned this issue Feb 15, 2021
Merged
12 tasks
uellue added a commit to LiberTEM/LiberTEM that referenced this issue Feb 15, 2021
@uellue
Temporary workaround Sphinx issue
9b757e2 
sphinx-doc/sphinx#8880
pllim added a commit to pllim/synphot_refactor that referenced this issue Feb 15, 2021
@pllim
Temp pin due to sphinx-doc/sphinx#8880
dd64150
This was referenced Mar 8, 2021
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Merged
Merged
Merged
Merged
Merged
Merged
Closed
Closed
Closed
Closed
This was referenced Mar 15, 2021
Closed
Closed
newling pushed a commit to graphcore/popart that referenced this issue Mar 15, 2021
@arp2600
Force specific version of sphinx.
f2a8acd 
Summary: Use sphinx version 3.4.3 until resolution of the linked issue: sphinx-doc/sphinx#8880

Reviewers: #popart, #framework_ip_review_-_any_oss_or_third-party_code_use_has_been_approved, samk, shirazb

Reviewed By: #popart, #framework_ip_review_-_any_oss_or_third-party_code_use_has_been_approved, samk, shirazb

Maniphest Tasks: T34329

Differential Revision: https://phabricator.sourcevertex.net/D40590
This was referenced Mar 16, 2021
Closed
Merged
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
extensions type:bug
Projects
None yet
Milestone
3.5.1
Development

Successfully merging a pull request may close this issue.

Sometimes _viewcode_modules can be False; don't crash when it is virtuald/sphinx
5 participants
@virtuald @tk0miya @xqt @ksunden @jfbu