Refactor API docs into separate sections

sot · Nov 19, 2023 · 44c3bfe · 44c3bfe
1 parent 44a63c6
commit 44c3bfe
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 38 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -7,41 +7,7 @@ Table of contents
 .. toctree::
    :maxdepth: 2
 
-
-Event models
-------------
-
-.. automodule:: kadi.events.models
-   :members:
-
-Event queries
--------------
-
-.. automodule:: kadi.events.query
-   :members:
-
-Commands
---------
-
-.. automodule:: kadi.commands.commands
-   :members:
-
-.. automodule:: kadi.commands.observations
-   :members:
-
-.. automodule:: kadi.commands.utils
-   :members:
-
-Command states
---------------
-
-.. automodule:: kadi.commands.states
-   :members:
-   :show-inheritance:
-
-
-Validation
-----------
-
-.. automodule:: kadi.commands.validate
-   :members:
+   api_events
+   api_commands
+   api_states
+   api_validation
diff --git a/docs/api_commands.rst b/docs/api_commands.rst
@@ -0,0 +1,21 @@
+====================================
+Commands API
+====================================
+
+Commands
+--------
+
+.. automodule:: kadi.commands.commands
+   :members:
+
+Observations
+------------
+
+.. automodule:: kadi.commands.observations
+   :members:
+
+Utils
+-----
+
+.. automodule:: kadi.commands.utils
+   :members:
diff --git a/docs/api_events.rst b/docs/api_events.rst
@@ -0,0 +1,15 @@
+====================================
+Events API
+====================================
+
+Event models
+------------
+
+.. automodule:: kadi.events.models
+   :members:
+
+Event queries
+-------------
+
+.. automodule:: kadi.events.query
+   :members:
diff --git a/docs/api_states.rst b/docs/api_states.rst
@@ -0,0 +1,10 @@
+====================================
+States API
+====================================
+
+Command states
+--------------
+
+.. automodule:: kadi.commands.states
+   :members:
+   :show-inheritance:
diff --git a/docs/api_validation.rst b/docs/api_validation.rst
@@ -0,0 +1,9 @@
+====================================
+Validation API
+====================================
+
+Validation
+----------
+
+.. automodule:: kadi.commands.validate
+   :members: