updated to auto docs pydantic

bluesky · Aug 13, 2024 · cb5abaf · cb5abaf
1 parent d5cce50
commit cb5abaf
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,6 +33,8 @@
  # Use this for generating API docs
  "sphinx.ext.autodoc",
  # This can parse google style docstrings
+ "sphinxcontrib.autodoc_pydantic",
+ # Used for BaseModel autodoc
  "sphinx.ext.napoleon",
  # For linking to external sphinx documentation
  "sphinx.ext.intersphinx",
@@ -84,6 +86,10 @@
  ("py:class", "starlette.responses.JSONResponse"),
 ]
 
+# pydantic models
+autodoc_pydantic_model_show_json = True
+autodoc_pydantic_model_show_config_summary = False
+
 # Both the class’ and the __init__ method’s docstring are concatenated and
 # inserted into the main body of the autoclass directive
 autoclass_content = "both"

diff --git a/pyproject.toml b/pyproject.toml
@@ -42,6 +42,7 @@ dev = [
  "pytest-cov",
  "ruff",
  "sphinx-autobuild",
+ "autodoc-pydantic",
  "sphinx-copybutton",
  "sphinx-design",
  "sphinxcontrib-openapi",