Sphinx updated on Zuul/Integration and this error prevents to pass any doc docker test, see https://gerrit.wikimedia.org/r/#/c/pywikibot/core/+/460119/.
Description
Description
Details
Details
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | Dalba | T204189 Doc source and destination directories cannot be identical since Sphinx 1.8.0 | |||
| Resolved | Morgan11235 | T187009 Pywikibot documentation build throws many warnings to console | |||
| Resolved | Dvorapa | T192255 Regenerate autodoc using apidoc | |||
| Resolved | zhuyifei1999 | T195663 Documentation build fails on tests.l10n_tests | |||
| Resolved | Xqt | T203675 No documentation is generated for makecat.py script | |||
| Resolved | matej_suchanek | T225861 Documentation build warning: missing attribute SiteLink in __all__ |
Event Timeline
Comment Actions
This is an [[ https://github.com/myint/rstcheck/issues/50 | upstream issue in rstcheck package ]].
As a temporary workaround we can stick with sphinx 1.7.9 until the upstream issue is fixed. Or maybe disable rstcheck?
Comment Actions
Change 460198 had a related patch set uploaded (by Dalba; owner: dalba):
[pywikibot/core@master] tox.ini: Do not install sphinx 1.8.0 until rstcheck issue is resolved
Comment Actions
Change 460198 merged by jenkins-bot:
[pywikibot/core@master] docs/requirements-py3.txt: Do not install sphinx 1.8.0
Comment Actions
Waiting for the upstream issue to be resolved, then we can remove the !=1.8.0 limitation from docs/requirements-py3.txt:5.
Comment Actions
Change 462124 had a related patch set uploaded (by Xqt; owner: Xqt):
[pywikibot/core@master] [test] docs/requirements-py3.txt: Do not install sphinx >=1.8.0
Comment Actions
Change 462124 merged by jenkins-bot:
[pywikibot/core@master] [test] docs/requirements-py3.txt: Do not install sphinx >=1.8.0
Comment Actions
Nobody is responsible upstream:
Sphinx: File an issue to rstcheck
rstcheck: Fix sphinx version to 1.7.9
Comment Actions
I believe we can remove rstcheck and let Sphinx raise error upon warnings. But before configuring Sphinx to do that, we need to resolve the remaining warnings (T187009).
Comment Actions
The issue was resolved in rstcheck 3.3.1, hopefully we can switch on a combination of rstcheck >= 3.3.1 and sphinx >= 1.8 now.
Yeah, that would be really convenient, only a few errors (129 of former 10 000-15 000) left there.
Comment Actions
Change 475037 had a related patch set uploaded (by Dalba; owner: dalba):
[pywikibot/core@master] docs/requirements-py3.txt: Use sphinx >= 1.8
Comment Actions
Change 475037 merged by jenkins-bot:
[pywikibot/core@master] docs/requirements-py3.txt: Use sphinx >= 1.8