Sphinx 4.3 will include a breaking change for autodoc_pydantic

[Yoshanuikabundi]

Hi! I've been lending a hand to contributing to Sphinx itself and discovered that my project no longer built on the upcoming release's branch. I bisected and reported this issue as sphinx-doc/sphinx#9832 and the wonderful Jakob Andersen has tracked the problem down to a change in signature for get_signature_prefix (https://www.sphinx-doc.org/en/master/changes.html#id2), which is apparently overwritten by autodoc_pydantic.

His comment is here: sphinx-doc/sphinx#9832 (comment)

He's written a mitigation but the behaviour will still be broken, just with a clearer error message. The release is expected to come out in the next few days. Thought you'd want a heads up!

[jakobandersen]

I suggest either requiring Sphinx 4.3 as a minimum version, or based on the Sphinx version return either a string or a list of nodes.

[mansenfranzen]

@Yoshanuikabundi Thanks for reporting the issue here and creating sphinx-doc/sphinx#9832. I will take care to make autodoc_pydantic work with sphinx version 4.3 in the next release. The required adjustment should not be too difficult.

@jakobandersen Thanks for providing the mitigation in the meanwhile.

[mansenfranzen]

@all-contributors please add @Yoshanuikabundi for test

[allcontributors]

@mansenfranzen

I've put up a pull request to add @Yoshanuikabundi! 🎉

[mansenfranzen]

@all-contributors please add @jakobandersen for code

[allcontributors]

@mansenfranzen

I've put up a pull request to add @jakobandersen! 🎉

[mansenfranzen]

@jakobandersen and @Yoshanuikabundi compatibility issues with sphinx 4.3 have been fixed and will be available in in the upcoming release v.1.5.1.