Page MenuHomePhabricator

Documentation is incomplete since Sphinx update to release 9 or 9.1
Closed, ResolvedPublicBUG REPORT

Description

master documentation is broken probably after sphinx was updated in rPWBC54f9635 but no warnings were given within CI.

Related Objects

Event Timeline

Xqt triaged this task as High priority.Dec 29 2025, 8:03 AM
Xqt changed the subtype of this task from "Task" to "Bug Report".

Change #1221591 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] Use Sphinx 8.2.3

https://gerrit.wikimedia.org/r/1221591

Change #1221591 merged by Xqt:

[pywikibot/core@master] Use Sphinx 8.2.3

https://gerrit.wikimedia.org/r/1221591

Change #1221594 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] Revert^2 "doc: replace directives describing changes between versions"

https://gerrit.wikimedia.org/r/1221594

Change #1221596 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] Revert^2 "doc: Update Sphinx"

https://gerrit.wikimedia.org/r/1221596

Change #1221596 merged by Xqt:

[pywikibot/core@master] Revert^2 "doc: Update Sphinx"

https://gerrit.wikimedia.org/r/1221596

Change #1221594 merged by Xqt:

[pywikibot/core@master] Revert^2 "doc: replace directives describing changes between versions"

https://gerrit.wikimedia.org/r/1221594

Change #1221614 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] Revert^3 "doc: replace directives describing changes between versions"

https://gerrit.wikimedia.org/r/1221614

Change #1221614 merged by Xqt:

[pywikibot/core@master] Revert^3 "doc: replace directives describing changes between versions"

https://gerrit.wikimedia.org/r/1221614

Change #1221615 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] doc: redurce Furo version

https://gerrit.wikimedia.org/r/1221615

Change #1221615 merged by Xqt:

[pywikibot/core@master] doc: redurce Furo version

https://gerrit.wikimedia.org/r/1221615

Xqt changed the task status from Open to Stalled.Dec 31 2025, 11:04 AM

Waiting for any upstream Sphinx tabs supporting Sphins 9.

Change #1224646 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] [doc] Retry using Sphinx 9

https://gerrit.wikimedia.org/r/1224646

Xqt changed the task status from Stalled to Open.Jan 8 2026, 12:33 PM

Change #1224646 merged by jenkins-bot:

[pywikibot/core@master] [doc] Retry using Sphinx 9

https://gerrit.wikimedia.org/r/1224646

Xqt renamed this task from Documentation is incomplete since Sphinx update to release 9 to Documentation is incomplete since Sphinx update to release 9 or 9.1.Jan 8 2026, 1:59 PM

Change #1224699 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] doc: use autodoc legacy to prevent missing files

https://gerrit.wikimedia.org/r/1224699

Change #1224699 merged by jenkins-bot:

[pywikibot/core@master] doc: use autodoc legacy to prevent missing files

https://gerrit.wikimedia.org/r/1224699

Change #1224703 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] doc: temporary deactivate sphinx patches

https://gerrit.wikimedia.org/r/1224703

Change #1224703 merged by jenkins-bot:

[pywikibot/core@master] doc: temporary deactivate sphinx patches

https://gerrit.wikimedia.org/r/1224703

Change #1224720 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] doc: Prevent parallel tasks in Sphinx

https://gerrit.wikimedia.org/r/1224720

I found the underlying problem in proofreadpage:

17:32:33   File "/src/.tox/doc/lib/python3.13/site-packages/sphinx/ext/viewcode.py", line 88, in _get_full_modname
17:32:33     value = getattr(value, attr)
17:32:33   File "/src/pywikibot/proofreadpage.py", line 182, in __get__
17:32:33     attr = self.attrs.get(obj)
17:32:33   File "/opt/pyenv/versions/3.13.5/lib/python3.13/weakref.py", line 452, in get
17:32:33     return self.data.get(ref(key),default)
17:32:33                          ~~~^^^^^
17:32:33 TypeError: cannot create weak reference to 'NoneType' object
17:32:33 viewcode can't import proofreadpage, failed with error "cannot create weak reference to 'NoneType' object"

Maybe Sphinx 8 was more tolerant.

Change #1224751 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] doc: Fall back to Sphinx 8.2.3 to enable online documentation again

https://gerrit.wikimedia.org/r/1224751

Change #1224751 merged by Xqt:

[pywikibot/core@master] doc: Fall back to Sphinx 8.2.3 to enable online documentation again

https://gerrit.wikimedia.org/r/1224751

Change #1224720 merged by Xqt:

[pywikibot/core@master] ProofreadPage: Never use None as key in WeakKeyDictionary

https://gerrit.wikimedia.org/r/1224720

Change #1234930 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@stable] sphinx: Use Sphinx 8.2.3 for documentation

https://gerrit.wikimedia.org/r/1234930

Change #1234930 merged by Xqt:

[pywikibot/core@stable] sphinx: Use Sphinx 8.2.3 for documentation

https://gerrit.wikimedia.org/r/1234930

Change #1249046 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] [doc] Retry using Sphinx 9

https://gerrit.wikimedia.org/r/1249046

Change #1249046 merged by Xqt:

[pywikibot/core@master] [doc] Retry using Sphinx 9 after sphinx-tabs was updated

https://gerrit.wikimedia.org/r/1249046

Xqt claimed this task.