📝 improve documentation

mraniki · Aug 8, 2023 · 8581b46 · 8581b46
1 parent 3754910
commit 8581b46
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 12 deletions.
diff --git a/docs/03_module.rst b/docs/03_module.rst
@@ -2,6 +2,11 @@
 TalkyTrader
 ===========
 
+.. automodule:: tt.bot
+    :members:
+    :undoc-members:
+
+
 API EndPoint
 ============
 
@@ -52,11 +57,9 @@ Plugins are the core of Talky Trader, they are loaded at startup and
 are used to interact with the trading platform.
 
 
-.. toctree::
-   :maxdepth: 2
-
-   plugins
-
+.. automodule:: tt.plugins
+    :members:
+    :undoc-members:
 
 
 TalkyTrader Module Reference
@@ -68,3 +71,6 @@ TalkyTrader Module Reference
    :recursive:
 
    tt
+
+
+
diff --git a/docs/plugins/helper.rst b/docs/plugins/helper.rst
@@ -5,12 +5,6 @@ helper
 Provide multiple function such as giving the list of 
 available command, network ping or restarting the bot
 
-.. toctree::
-   :maxdepth: 2
-
-   plugins/helper
-
-
 Function
 =====
 
@@ -38,4 +32,7 @@ Restart
 Module Reference
 ================
 
-.. automodule::tt.plugins.default_plugins.helper_plugin
+.. automodule:: tt.plugins.default_plugins.helper_plugin
+    :members:
+    :undoc-members:
+