Skip to content

Fix autodoc overriding#400

Merged
A5rocks merged 3 commits intopython-trio:masterfrom
A5rocks:override-fix
Jan 29, 2026
Merged

Fix autodoc overriding#400
A5rocks merged 3 commits intopython-trio:masterfrom
A5rocks:override-fix

Conversation

@A5rocks
Copy link
Contributor

@A5rocks A5rocks commented Jan 23, 2026

I'm fairly certain this fixes #399. At least there's no warning when building the end-to-end test document, though note that the regexes are all screwy so I haven't put in the effort to make sure it's still right (so tests will still fail)!

@A5rocks
Copy link
Contributor Author

A5rocks commented Jan 23, 2026

CI failures are tracked by #260 so don't let that scare you away!


def mess_with_autodoc(app):
app.add_autodocumenter(ExtendedFunctionDocumenter, override=True)
app.add_autodocumenter(ExtendedMethodDocumenter, override=True)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems override=True is Sphinx 2.2 or later... That's old enough that I think it's OK to drop support for earlier versions?

@A5rocks
Copy link
Contributor Author

A5rocks commented Jan 29, 2026

OK based on python-trio/trio#3383 this works. I'm going to merge this in and cut a release!

@A5rocks A5rocks merged commit aa122de into python-trio:master Jan 29, 2026
0 of 14 checks passed
@A5rocks A5rocks deleted the override-fix branch January 29, 2026 07:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incompatibility with sphinx 9.0

1 participant