Remove sphinx.ext.napoleon due to RemovedInSphinx11Warning
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Xqt
	Aug 30 2026, 12:36 PM

Project Tags

Referenced Files

None

Subscribers

Description

Description

Pywikibot currently uses sphinx.ext.napoleon together with sphinx.ext.autodoc. With Sphinx 9.1 this combination produces several pages of RemovedInSphinx11Warning warnings.

See the upstream Sphinx issue:

https://github.com/sphinx-doc/sphinx/issues/14270

Napoleon is primarily needed to support Google-style docstrings, which Pywikibot does not use. There are only a few remaining constructs in the documentation that Napoleon currently formats specially, such as Example, Examples, Advice, Hints, and Rights sections.

Proposed solution

Remove sphinx.ext.napoleon from the Sphinx configuration and convert the remaining Napoleon-specific constructs to regular Sphinx/reStructuredText markup. The existing documentation should remain unchanged.

Details

Related Changes in Gerrit:

	Subject	Author	Repo	Branch	Lines +/-
	[docs] Remove sphinx.ext.napoleon due to RemovedInSphinx11Warning	Xqt	pywikibot/core	master	+237 -246

Customize query in gerrit

Event Timeline

Xqt created this task.Aug 30 2026, 12:36 PM

Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald TranscriptAug 30 2026, 12:36 PM

Xqt claimed this task.Aug 30 2026, 12:36 PM

Xqt triaged this task as Medium priority.

Mahveotm subscribed.Aug 30 2026, 12:37 PM

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

[pywikibot/core@master] [docs] Remove sphinx.ext.napoleon due to RemovedInSphinx11Warning

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

gerritbot added a project: Patch-For-Review.Aug 30 2026, 12:37 PM

Xqt closed this task as Resolved.Sep 5 2026, 2:18 PM

Change #1332482 merged by jenkins-bot: