From f8b68fa1a10e4ef8481add9e295d9d615ba1f760 Mon Sep 17 00:00:00 2001 From: Fede Raimondo Date: Mon, 21 Oct 2024 18:17:23 +0200 Subject: [PATCH] Add config module to doc --- docs/api/config.rst | 21 +++++++++++++++++++++ docs/api/index.rst | 1 + 2 files changed, 22 insertions(+) create mode 100644 docs/api/config.rst diff --git a/docs/api/config.rst b/docs/api/config.rst new file mode 100644 index 000000000..525a5ab45 --- /dev/null +++ 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 index 31d1f1f17..b05427e8c 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -18,3 +18,4 @@ API Reference prepare.rst stats.rst viz.rst + config.rst \ No newline at end of file