Add config module to doc

juaml · Oct 21, 2024 · f8b68fa · f8b68fa
1 parent 3aa6f3e
commit f8b68fa
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/docs/api/config.rst b/docs/api/config.rst
@@ -0,0 +1,21 @@
+Config
+======
+
+.. automodule:: julearn.config
+   :no-members:
+   :no-inherited-members:
+
+
+See :ref:`configuration` for more information on the flags that can be set.
+
+Functions
+---------
+
+.. currentmodule:: julearn.config
+
+.. autosummary::
+   :toctree: generated/
+   :template: function.rst
+
+    set_config
+    get_config
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -18,3 +18,4 @@ API Reference
    prepare.rst
    stats.rst
    viz.rst
+   config.rst