Structured documentation for api

RookieGameDevs · Feb 14, 2017 · e923611 · e923611
1 parent 1982efd
commit e923611
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 9 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,13 +1,13 @@
-API documentation
 =================
-.. automodule:: revived
-   :members:
-
-.. automodule:: revived.action
-   :members:
+API Documentation
+=================
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
 
-.. automodule:: revived.reducer
-   :members:
+   api/store
+   api/reducer
+   api/action
 
-.. automodule:: revived.store
+.. automodule:: revived
    :members:
diff --git a/docs/api/action.rst b/docs/api/action.rst
@@ -0,0 +1,6 @@
+=======================================
+``revived.action`` module documentation
+=======================================
+
+.. automodule:: revived.action
+   :members:
diff --git a/docs/api/reducer.rst b/docs/api/reducer.rst
@@ -0,0 +1,6 @@
+========================================
+``revived.reducer`` module documentation
+========================================
+
+.. automodule:: revived.reducer
+   :members:
diff --git a/docs/api/store.rst b/docs/api/store.rst
@@ -0,0 +1,6 @@
+======================================
+``revived.store`` module documentation
+======================================
+
+.. automodule:: revived.store
+   :members: