From 8581b46bd30beca2eb01fe95a2020aa2d8fe9abf Mon Sep 17 00:00:00 2001 From: mraniki Date: Tue, 8 Aug 2023 21:03:37 +0200 Subject: [PATCH] :memo: improve documentation --- docs/03_module.rst | 16 +++++++++++----- docs/plugins/helper.rst | 11 ++++------- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/docs/03_module.rst b/docs/03_module.rst index 505583248..ddf3b5511 100644 --- 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 index 88d93f00c..da4c7f2c5 100644 --- 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 \ No newline at end of file +.. automodule:: tt.plugins.default_plugins.helper_plugin + :members: + :undoc-members: + \ No newline at end of file