【文件属性】:
文件名称:autodoc_pydantic:将pydantic模型无缝集成到您的Sphinx文档中
文件大小:14KB
文件格式:ZIP
更新时间:2021-03-30 23:26:07
python sphinx autodoc pydantic Python
autodoc_pydantic
你爱 :red_heart: 您想用记录模型和配置设置吗?
完美,走吧。 但是,等等,sphinx的与pydantic模型集成得不是很好 :confused_face: 。
不用担心-只需pip install autodoc_pydantic :smiling_face: 。
特征
:speech_balloon: 提供模型字段的默认值,别名和约束
:link: 在验证器和相应字段之间添加引用
:page_with_curl: 包含可折叠模型json模式
:person_surfing: 与autodoc扩展本地集成
:paperclip: 为模型,设置,字段,验证器和模型配置定义显式的pydantic前缀
:clipboard: 显示模型配置和验证器的摘要部分
:eyes: 隐藏过载和冗余的模型类签名
:books: 按类型对模型中的字段,验证器和模型配置进行排序
:four_leaf_clover: 支持pydantic >= 1.0.0和sphinx >= 3.0.0
所有这些插件都是完全可配置的。
安装
通过pip
【文件预览】:
autodoc_pydantic-main
----pyproject.toml(577B)
----sphinxcontrib()
--------autodoc_pydantic()
--------__init__.py(0B)
----.github()
--------workflows()
----README.md(4KB)
----tests()
--------conftest.py(2KB)
--------test_autodoc.py(3KB)
--------roots()