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
Sphinx 3.1.0 build fails with unexpected indentation on @classproperty with no docstring #7805
Labels
Milestone
Comments
dvorapa
changed the title
Sphinx 3.1.0 build fails with unexpected indentation on classproperty with no docstring
Sphinx 3.1.0 build fails with unexpected indentation on @classproperty with no docstring
Jun 9, 2020
wmfgerrit
pushed a commit
to wikimedia/pywikibot
that referenced
this issue
Jun 9, 2020
sphinx-doc/sphinx#7805 Change-Id: I694f1be3593c6fc95928d24677f313705b70952b
I confired the error:
And it seems Sphinx internally generates a following reST source for
I don't know why it returns dict's docstring. But this is why Sphinx causes "unexpected indentation" error. I'll continue to investigate this. |
Note: This would be a side effect of #7557. |
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Jun 13, 2020
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Jun 13, 2020
tk0miya
added a commit
to tk0miya/sphinx
that referenced
this issue
Jun 14, 2020
tk0miya
added a commit
that referenced
this issue
Jun 14, 2020
Fix #7805: autodoc: an object which descriptors returns is documented
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Describe the bug
Since update to Sphinx 3.1.0, Pywikibot build fails with "unexpected indentation" on a @classproperty with no docstring. The error can be found here: https://integration.wikimedia.org/ci/job/pywikibot-core-tox-doc-docker/10136/console
To Reproduce
Steps to reproduce the behavior:
Expected behavior
rstcheck does not report any error and build under Sphinx 3.0.4 worked. There should be no difference or clearly defined, what's wrong with our code. I read changelog for 3.1.0 thoroughly, but could not find any indication, what is wrong. Also the error message is not much informative.
You can see the problematic @classproperty here: https://phabricator.wikimedia.org/diffusion/PWBC/browse/master/pywikibot/families/wikisource_family.py$71
Your project
Link to your sphinx project, or attach zipped small project sample.
https://github.com/wikimedia/pywikibot
Environment info
Additional context
Console output: https://integration.wikimedia.org/ci/job/pywikibot-core-tox-doc-docker/10136/console
Problematic @classproperty: https://phabricator.wikimedia.org/diffusion/PWBC/browse/master/pywikibot/families/wikisource_family.py$71
The text was updated successfully, but these errors were encountered: