Moved API docs up a level

minima-global · Dec 30, 2020 · 42600f4 · 42600f4
1 parent d8469c4
commit 42600f4
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 60 deletions.
diff --git a/docs/api/api.rst b/docs/api/api.rst
@@ -0,0 +1,69 @@
+####################
+Minima API Functions
+####################
+
+The Minima API is used to create MiniDapps.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Top-level API:
+
+   top/init.rst
+   top/notify.rst
+   top/log.rst
+   top/cmd.rst
+   top/sql.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Utility API:
+
+   util/getBalance.rst
+   util/getStateVariable.rst
+   util/checkAllResponses.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Form API:
+
+   form/getParams.rst
+   form/params.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: File API:
+
+   file/saveHEX.rst
+   file/move.rst
+   file/copy.rst
+   file/save.rst
+   file/delete.rst
+   file/list.rst
+   file/loadHEX.rst
+   file/load.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Net API:
+
+   net/POST.rst
+   net/start.rst
+   net/disconnect.rst
+   net/onOutbound.rst
+   net/GET.rst
+   net/connect.rst
+   net/onInbound.rst
+   net/stats.rst
+   net/broadcast.rst
+   net/stop.rst
+   net/send.rst
+   net/info.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: MiniDapps API:
+
+   minidapps/listen.rst
+   minidapps/list.rst
+   minidapps/send.rst
+   minidapps/reply.rst
diff --git a/docs/api/cmd.rst → docs/api/top/cmd.rst b/docs/api/cmd.rst → docs/api/top/cmd.rst
diff --git a/docs/api/init.rst → docs/api/top/init.rst b/docs/api/init.rst → docs/api/top/init.rst
diff --git a/docs/api/log.rst → docs/api/top/log.rst b/docs/api/log.rst → docs/api/top/log.rst
diff --git a/docs/api/notify.rst → docs/api/top/notify.rst b/docs/api/notify.rst → docs/api/top/notify.rst
diff --git a/docs/api/sql.rst → docs/api/top/sql.rst b/docs/api/sql.rst → docs/api/top/sql.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -24,64 +24,6 @@ Contents
 
 .. toctree::
    :maxdepth: 2
-   :caption: Top-level API:
+   :caption: API:
 
-   api/init.rst
-   api/notify.rst
-   api/log.rst
-   api/cmd.rst
-   api/sql.rst
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Utility API:
-
-   api/util/getBalance.rst
-   api/util/getStateVariable.rst
-   api/util/checkAllResponses.rst
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Form API:
-
-   api/form/getParams.rst
-   api/form/params.rst
-
-.. toctree::
-   :maxdepth: 2
-   :caption: File API:
-
-   api/file/saveHEX.rst
-   api/file/move.rst
-   api/file/copy.rst
-   api/file/save.rst
-   api/file/delete.rst
-   api/file/list.rst
-   api/file/loadHEX.rst
-   api/file/load.rst
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Net API:
-
-   api/net/POST.rst
-   api/net/start.rst
-   api/net/disconnect.rst
-   api/net/onOutbound.rst
-   api/net/GET.rst
-   api/net/connect.rst
-   api/net/onInbound.rst
-   api/net/stats.rst
-   api/net/broadcast.rst
-   api/net/stop.rst
-   api/net/send.rst
-   api/net/info.rst
-
-.. toctree::
-   :maxdepth: 2
-   :caption: MiniDapps API:
-
-   api/minidapps/listen.rst
-   api/minidapps/list.rst
-   api/minidapps/send.rst
-   api/minidapps/reply.rst
+   api/api.rst