From bb3e5a7edcd9448f061e8e2823aed65b577a5de6 Mon Sep 17 00:00:00 2001 From: Alex Root Junior Date: Fri, 21 Sep 2018 23:04:35 +0300 Subject: [PATCH] Update docs structure --- docs/source/dispatcher/filters.rst | 19 +++++++++++ docs/source/dispatcher/fsm.rst | 45 +++++++++++++++++++++++++++ docs/source/dispatcher/index.rst | 30 +++++++++++++++++- docs/source/dispatcher/middleware.rst | 15 +++++++++ docs/source/utils/index.rst | 14 ++++++++- 5 files changed, 121 insertions(+), 2 deletions(-) create mode 100644 docs/source/dispatcher/filters.rst create mode 100644 docs/source/dispatcher/fsm.rst create mode 100644 docs/source/dispatcher/middleware.rst diff --git a/docs/source/dispatcher/filters.rst b/docs/source/dispatcher/filters.rst new file mode 100644 index 00000000..2615a0f7 --- /dev/null +++ b/docs/source/dispatcher/filters.rst @@ -0,0 +1,19 @@ +======= +Filters +======= + +Basics +====== +Coming soon... + +Filters factory +=============== +Coming soon... + +Builtin filters +=============== +Coming soon... + +Making own filters (Custom filters) +=================================== +Coming soon... diff --git a/docs/source/dispatcher/fsm.rst b/docs/source/dispatcher/fsm.rst new file mode 100644 index 00000000..93c94aa6 --- /dev/null +++ b/docs/source/dispatcher/fsm.rst @@ -0,0 +1,45 @@ +==================== +Finite state machine +==================== + +Storage +======= +Coming soon... + +Available storage's +------------------- +Coming soon... + +Memory storage +~~~~~~~~~~~~~~ +Coming soon... + +Redis storage +~~~~~~~~~~~~~ +Coming soon... + +Rethink DB storage +~~~~~~~~~~~~~~~~~~ +Coming soon... + +Making own storage's +~~~~~~~~~~~~~~~~~~~~ +Coming soon... + + +States +====== +Coming soon... + + +State utils +=========== +Coming soon... + +State +----- +Coming soon... + +States group +------------ +Coming soon... diff --git a/docs/source/dispatcher/index.rst b/docs/source/dispatcher/index.rst index 5535f4b1..d874f2e4 100644 --- a/docs/source/dispatcher/index.rst +++ b/docs/source/dispatcher/index.rst @@ -1,4 +1,32 @@ +========== Dispatcher ========== -TODO +.. toctree:: + + filters + fsm + middleware + +Basics +====== +Coming soon... + +Available handlers +================== +Coming soon... + +Handler class +------------- +Coming soon... + +Features +======== +Coming soon... + +Dispatcher class +================ + +.. autoclass:: aiogram.Dispatcher + :members: + :show-inheritance: diff --git a/docs/source/dispatcher/middleware.rst b/docs/source/dispatcher/middleware.rst new file mode 100644 index 00000000..fc73b79f --- /dev/null +++ b/docs/source/dispatcher/middleware.rst @@ -0,0 +1,15 @@ +========== +Middleware +========== + +Bases +===== +Coming soon... + +Making own middleware's +======================= +Coming soon... + +Available middleware's +====================== +Coming soon... diff --git a/docs/source/utils/index.rst b/docs/source/utils/index.rst index 76377aa5..bc4a52ed 100644 --- a/docs/source/utils/index.rst +++ b/docs/source/utils/index.rst @@ -1,4 +1,16 @@ Utils ===== -TODO \ No newline at end of file +.. toctree:: + + executor + exceptions + context + markdown + helper + auth_widget + payload + parts + json + emoji + deprecated