temporary changes to build docs without autodoc_pydantic

dougiesquire · Jul 6, 2023 · a6a2fcf · a6a2fcf
1 parent 2bfbe5a
commit a6a2fcf
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/ci/environment-docs.yml b/ci/environment-docs.yml
@@ -5,7 +5,7 @@ channels:
 dependencies:
   - cftime
   - distributed
-  - ecgtools >=2022.10.7
+#  - ecgtools >=2022.10.7
   - fsspec>=2023.05
   - gcsfs >=2023.05
   - intake>=0.7
@@ -30,3 +30,4 @@ dependencies:
       - sphinxext-opengraph
       - autodoc_pydantic
       - -e ..
+      - git+https://github.com/ncar-xdev/ecgtools.git@refs/pull/164/head
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -16,7 +16,6 @@
     'myst_nb',
     'sphinxext.opengraph',
     'sphinx_copybutton',
-    'sphinxcontrib.autodoc_pydantic',
     'sphinx_design',
 ]
 
@@ -29,9 +28,6 @@
 copybutton_prompt_text = r'>>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: '
 copybutton_prompt_is_regexp = True
 
-autodoc_pydantic_model_show_json = True
-autodoc_pydantic_model_show_config = False
-
 nb_execution_mode = 'cache'
 nb_execution_timeout = 600
 nb_execution_raise_on_error = True

diff --git a/docs/source/reference/api.md b/docs/source/reference/api.md
@@ -24,13 +24,19 @@ For more details and examples, refer to the relevant chapters in the main part o
 ## ESM Catalog
 
 ```{eval-rst}
-.. autopydantic_model:: intake_esm.cat.ESMCatalogModel
+.. autoclass:: intake_esm.cat.ESMCatalogModel
+    :members:
+    :noindex:
+    :special-members: __init__
 ```
 
 ## Query Model
 
 ```{eval-rst}
-.. autopydantic_model:: intake_esm.cat.QueryModel
+.. autoclass:: intake_esm.cat.QueryModel
+    :members:
+    :noindex:
+    :special-members: __init__
 ```
 
 ## Derived Variable Registry