update doc

ecmwf · Apr 16, 2024 · 820303b · 820303b
1 parent 0dc98cd
commit 820303b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/anemoi/utils/provenance.py b/anemoi/utils/provenance.py
@@ -191,6 +191,13 @@ def _paths(path_or_object):
 
 
 def git_check(*args):
+    """_summary_
+
+    Returns
+    -------
+    _type_
+        _description_
+    """
     paths = _paths(args if len(args) > 0 else None)
 
     git = _check_for_git(paths, full=True)

diff --git a/docs/conf.py b/docs/conf.py
@@ -59,6 +59,8 @@
     "nbsphinx",
     "sphinx.ext.graphviz",
     "sphinx.ext.intersphinx",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/index.rst b/docs/index.rst
@@ -30,6 +30,14 @@ of the *Anemoi* packages.
 
    installing
 
+***********
+ functions
+***********
+
+.. currentmodule:: anemoi.utils.provenance
+
+.. autofunction:: git_check
+
 *****************
  Anemoi packages
 *****************