Sphinx: 使用autodoc渲染继承的重载

此扩展通过在 autodoc-process-signature 事件期间手动解析重载，解决了Sphinx中autodoc不显示继承的 @overload 签名的小问题。动态地，只能使用 typing.get_overloads() 函数来获取函数的重载，该函数是在Python 3.11中引入的。因此，这是一个硬性要求。

安装

对于测试，您可以从pip安装 sphinxcontrib.autodoc_inherit_overload 包

pip install sphinxcontrib.autodoc_inherit_overload

当将包添加到您的依赖项时，请确保您保护了不正确的Python版本

sphinxcontrib.autodoc_inherit_overload; python_version>='3.11'

这同样适用于在您的 conf.py 中加载扩展

extensions = [
    # your extensions
    ...
]
if sys.version_info >= (3, 11):
    extensions += ['sphinxcontrib.autodoc_inherit_overload']