Browse Source

Update docs structure

Denis K 8 years ago
parent
commit
81d1b7466a
4 changed files with 29 additions and 12 deletions
  1. 0 1
      docs/dashboard.rst
  2. 21 0
      docs/dashboard_api.rst
  3. 0 11
      docs/dashboard_base.rst
  4. 8 0
      docs/index.rst

+ 0 - 1
docs/dashboard.rst

@@ -8,4 +8,3 @@ Dashboard
    dashboard_getting_started
    dashboard_modules
    dashboard_custom_module
-   dashboard_base

+ 21 - 0
docs/dashboard_api.rst

@@ -0,0 +1,21 @@
+=============
+Dashboard API
+=============
+
+This page describes the API of the dashboard and dashboard modules.
+
+.. _Dashboard:
+
+Dashboard
+---------
+
+.. autoclass:: jet.dashboard.dashboard.Dashboard
+   :members:
+
+.. _Dashboard Module:
+
+DashboardModule
+---------------
+
+.. autoclass:: jet.dashboard.modules.DashboardModule
+   :members:

+ 0 - 11
docs/dashboard_base.rst

@@ -1,11 +0,0 @@
-============
-Base Classes
-============
-
-.. _Dashboard:
-.. autoclass:: jet.dashboard.dashboard.Dashboard
-   :members:
-
-.. _Dashboard Module:
-.. autoclass:: jet.dashboard.modules.DashboardModule
-   :members:

+ 8 - 0
docs/index.rst

@@ -36,6 +36,14 @@ Dashboard
 
    dashboard
 
+Dashboard API
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   dashboard_api
+
 License
 =======