docs: auto-generate docs with sphinx

qdrant · Jun 3, 2022 · a725c67 · a725c67
1 parent 4fca215
commit a725c67
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 2 deletions.
diff --git a/docs/source/quaterion.train.callbacks.cleanup_callback.rst b/docs/source/quaterion.train.callbacks.cleanup_callback.rst
@@ -0,0 +1,7 @@
+quaterion.train.callbacks.cleanup\_callback module
+==================================================
+
+.. automodule:: quaterion.train.callbacks.cleanup_callback
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/quaterion.train.callbacks.metrics_callback.rst b/docs/source/quaterion.train.callbacks.metrics_callback.rst
@@ -0,0 +1,7 @@
+quaterion.train.callbacks.metrics\_callback module
+==================================================
+
+.. automodule:: quaterion.train.callbacks.metrics_callback
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/quaterion.train.callbacks.rst b/docs/source/quaterion.train.callbacks.rst
@@ -0,0 +1,19 @@
+quaterion.train.callbacks package
+=================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   quaterion.train.callbacks.cleanup_callback
+   quaterion.train.callbacks.metrics_callback
+
+Module contents
+---------------
+
+.. automodule:: quaterion.train.callbacks
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/quaterion.train.rst b/docs/source/quaterion.train.rst
@@ -8,6 +8,7 @@ Subpackages
    :maxdepth: 4
 
    quaterion.train.cache
+   quaterion.train.callbacks
 
 Submodules
 ----------
@@ -16,8 +17,6 @@ Submodules
    :maxdepth: 4
 
    quaterion.train.cache_mixin
-   quaterion.train.cleanup_callback
-   quaterion.train.metrics_callback
    quaterion.train.trainable_model
 
 Module contents

diff --git a/docs/source/quaterion.utils.progress_bar.rst b/docs/source/quaterion.utils.progress_bar.rst
@@ -0,0 +1,7 @@
+quaterion.utils.progress\_bar module
+====================================
+
+.. automodule:: quaterion.utils.progress_bar
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/quaterion.utils.rst b/docs/source/quaterion.utils.rst
@@ -8,6 +8,7 @@ Submodules
    :maxdepth: 4
 
    quaterion.utils.enums
+   quaterion.utils.progress_bar
    quaterion.utils.utils
 
 Module contents