Disable autodoc_pydantic for now

dgbowl · Jul 15, 2024 · c80a6c4 · c80a6c4
1 parent 640bfdf
commit c80a6c4
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -39,7 +39,7 @@
     # "sphinx.ext.autosummary",
     # "sphinx_autodoc_typehints",
     "sphinx_rtd_theme",
-    "sphinxcontrib.autodoc_pydantic",
+    # "sphinxcontrib.autodoc_pydantic",
     "sphinxcontrib.mermaid",
 ]
 

diff --git a/src/tomato/drivers.py b/src/tomato/drivers.py
@@ -1,5 +1,9 @@
 """
-Driver documentation goes here.
+**tomato.drivers**: Shim interfacing with tomato driver packages
+----------------------------------------------------------------
+.. codeauthor::
+    Peter Kraus
+
 """
 
 import importlib

diff --git a/src/tomato/models.py b/src/tomato/models.py
@@ -1,3 +1,9 @@
+"""
+**tomato.models**: Pydantic models for internal tomato use
+----------------------------------------------------------
+.. codeauthor::
+    Peter Kraus
+"""
 from pydantic import BaseModel, Field
 from typing import Optional, Any, Mapping, Sequence, Literal
 from pathlib import Path