Merge pull request #125 from ACCESS-NRI/fix_update_docs

Fix and update documentation
ACCESS-NRI · Oct 9, 2023 · 61784fb · 61784fb
2 parents 810e88c + 45769df
commit 61784fb
Show file tree

Hide file tree

Showing 4 changed files with 1,125 additions and 1,193 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -45,7 +45,7 @@
 # autoapi directives
 autoapi_dirs = ["../src/access_nri_intake"]
 autoapi_add_toctree_entry = False
-autoapi_ignore = ["*/*.ipynb_checkpoints"]
+autoapi_ignore = ["*/.ipynb_checkpoints", "*/_version.py", "*/__init__.py"]
 autoapi_python_class_content = "both"
 autoapi_options = [
     "members",

diff --git a/docs/datastores/quickstart.ipynb b/docs/datastores/quickstart.ipynb
diff --git a/docs/environment-doc.yaml b/docs/environment-doc.yaml
@@ -4,6 +4,7 @@ channels:
   - defaults
 dependencies:
   - python==3.11
+  - astroid<3.0 # see https://github.com/readthedocs/sphinx-autoapi/issues/407
   - hdf5
   - ipython
   - numpy