docs: Add API Docs

.readthedocs.yaml

@@ -3,7 +3,10 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.11"
+  jobs:
+    pre_build:
+      - bash docs/scripts/api_build.sh
 
 sphinx:
   configuration: docs/conf.py

docs/Makefile

@@ -19,4 +19,5 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
+	bash $(SOURCEDIR)/scripts/api_build.sh
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_templates/apidoc/package.rst.jinja

@@ -0,0 +1,55 @@
+{%- macro automodule(modname, options) -%}
+.. automodule:: {{ modname }}
+{%- for option in options %}
+   :{{ option }}:
+{%- endfor %}
+{%- endmacro %}
+
+{%- macro toctree(docnames) -%}
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
+{%- endmacro %}
+
+{%- if is_namespace %}
+{{- pkgname.split(".")[1:] | join(".") | e | heading }}
+{% else %}
+{{- pkgname.split(".")[1:] | join(" ") | e | heading }}
+{% endif %}
+
+{%- if is_namespace %}
+.. py:module:: {{ pkgname }}
+{% endif %}
+
+{%- if modulefirst and not is_namespace %}
+{{ automodule(["anemoi", pkgname] | join("."), [""]) }}
+{% endif %}
+
+{%- if subpackages %}
+Subpackages
+-----------
+
+{{ toctree(subpackages) }}
+{% endif %}
+
+{%- if submodules %}
+{% if separatemodules %}
+{{ toctree(submodules) }}
+{% else %}
+{%- for submodule in submodules %}
+{% if show_headings %}
+{{- submodule.split(".")[2:] | join(".") | e | heading(2) }}
+{% endif %}
+{{ automodule(["anemoi", submodule] | join("."), automodule_options) }}
+{% endfor %}
+{%- endif %}
+{%- endif %}
+
+{%- if not modulefirst and not is_namespace %}
+Module contents
+---------------
+
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}

docs/modules/create.rst

@@ -2,6 +2,10 @@
  Create
 ########
 
+This module contains the neccessary functions to create a dataset. It
+interfaces with the data on disk, and provides methods to prepare it for
+use in Anemoi.
+
 .. automodule:: anemoi.datasets.create
    :members:
    :no-undoc-members:

docs/modules/data.rst

@@ -4,12 +4,4 @@
  Data
 ######
 
-.. automodule:: anemoi.datasets.data.__init__
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-.. automodule:: anemoi.datasets.data.dataset
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
+.. include:: ../_api/datasets.data.rst

docs/modules/filters.rst

@@ -0,0 +1,5 @@
+#########
+ Filters
+#########
+
+.. include:: ../_api/datasets.create.filters.rst

docs/modules/sources.rst

@@ -0,0 +1,5 @@
+#########
+ Sources
+#########
+
+.. include:: ../_api/datasets.create.sources.rst

docs/scripts/api_build.sh

@@ -0,0 +1,6 @@
+
+script_dir=$(dirname "${BASH_SOURCE[0]}")
+docs_dir="$script_dir/.."
+source_dir="$script_dir/../../src/"
+
+sphinx-apidoc -M -f -o "$docs_dir/_api" "$source_dir/anemoi" -t "$docs_dir/_templates/apidoc"

pyproject.toml

@@ -77,6 +77,7 @@ optional-dependencies.dev = [
 ]
 
 optional-dependencies.docs = [
+  "anemoi-datasets[all]",
   "nbsphinx",
   "pandoc",
   "sphinx",