Improve API doc navigation and coverage (#141)

[osm/N2VC.git] / docs / api / modules.rst

diff --git a/docs/api/modules.rst b/docs/api/modules.rst
index d65e5ad..bf06f26 100644 (file)
--- a/docs/api/modules.rst
+++ b/docs/api/modules.rst
@@ -1,7 +1,31 @@
-API Docs
-========
+juju
+====
+
+It is recommended that you start with :doc:`juju.model` or :doc:`juju.controller`.
+If you need helpers to manage the asyncio loop, try :doc:`juju.loop`.
 
 .. toctree::
-   :maxdepth: 4
 
-   juju
+    juju.action
+    juju.annotation
+    juju.application
+    juju.cloud
+    juju.constraints
+    juju.controller
+    juju.delta
+    juju.errors
+    juju.exceptions
+    juju.juju
+    juju.loop
+    juju.machine
+    juju.model
+    juju.placement
+    juju.relation
+    juju.tag
+    juju.unit
+    juju.utils
+
+.. automodule:: juju
+    :members:
+    :undoc-members:
+    :show-inheritance: