autodoc_pydantic: 显示来自父模型的字段
autodoc_pydantic: Show fields from parent model
我正在使用 Sphinx 的 autodoc_pydantic
插件来记录我的 pydantic.BaseModel
classes。但是,有些情况下我会遇到类似
class Foo(pydantic.BaseModel):
'''Foo class'''
x: str = pydantic.Field(description='The x.')
class Bar(Foo):
'''Bar class'''
y: int = pydantic.Field(description='The y.')
我的 .rst 文件包含指令
.. automodule:: foo.foo
:members:
生成文档时,Bar
class 仅显示 y
字段。有没有办法让 autodoc_pydantic
在 Bar
的描述中同时显示 x
和 y
?
可以通过:inherited-members:
选项完成:
.. automodule:: foo.foo
:inherited-members: BaseModel
我正在使用 Sphinx 的 autodoc_pydantic
插件来记录我的 pydantic.BaseModel
classes。但是,有些情况下我会遇到类似
class Foo(pydantic.BaseModel):
'''Foo class'''
x: str = pydantic.Field(description='The x.')
class Bar(Foo):
'''Bar class'''
y: int = pydantic.Field(description='The y.')
我的 .rst 文件包含指令
.. automodule:: foo.foo
:members:
生成文档时,Bar
class 仅显示 y
字段。有没有办法让 autodoc_pydantic
在 Bar
的描述中同时显示 x
和 y
?
可以通过:inherited-members:
选项完成:
.. automodule:: foo.foo
:inherited-members: BaseModel