python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2026-04-08 16:37:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update docs

Browse source
This commit is contained in:
Alex Root Junior 2020-09-14 22:56:11 +03:00
parent 7c65344dcd
commit 7b33e5c68a
8 changed files with 55 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

50
docs/source/dispatcher/filters.rst
View file

@ -10,7 +10,7 @@ Filter factory greatly simplifies the reuse of filters when registering handlers
Filters factory
===============
.. autoclass:: aiogram.dispatcher.filters.factory.FiltersFactory
.. autoclass:: aiogram.dispatcher.filters.FiltersFactory
:members:
:show-inheritance:
@ -21,28 +21,28 @@ Builtin filters
Command
-------
.. autoclass:: aiogram.dispatcher.filters.builtin.Command
.. autoclass:: aiogram.dispatcher.filters.Command
:members:
:show-inheritance:
CommandStart
------------
.. autoclass:: aiogram.dispatcher.filters.builtin.CommandStart
.. autoclass:: aiogram.dispatcher.filters.CommandStart
:members:
:show-inheritance:
CommandHelp
-----------
.. autoclass:: aiogram.dispatcher.filters.builtin.CommandHelp
.. autoclass:: aiogram.dispatcher.filters.CommandHelp
:members:
:show-inheritance:
CommandSettings
---------------
.. autoclass:: aiogram.dispatcher.filters.builtin.CommandSettings
.. autoclass:: aiogram.dispatcher.filters.CommandSettings
:members:
:show-inheritance:
@ -50,7 +50,7 @@ CommandSettings
CommandPrivacy
--------------
.. autoclass:: aiogram.dispatcher.filters.builtin.CommandPrivacy
.. autoclass:: aiogram.dispatcher.filters.CommandPrivacy
:members:
:show-inheritance:
@ -58,7 +58,7 @@ CommandPrivacy
Text
----
.. autoclass:: aiogram.dispatcher.filters.builtin.Text
.. autoclass:: aiogram.dispatcher.filters.Text
:members:
:show-inheritance:
@ -66,7 +66,7 @@ Text
HashTag
-------
.. autoclass:: aiogram.dispatcher.filters.builtin.HashTag
.. autoclass:: aiogram.dispatcher.filters.HashTag
:members:
:show-inheritance:
@ -74,7 +74,7 @@ HashTag
Regexp
------
.. autoclass:: aiogram.dispatcher.filters.builtin.Regexp
.. autoclass:: aiogram.dispatcher.filters.Regexp
:members:
:show-inheritance:
@ -82,7 +82,7 @@ Regexp
RegexpCommandsFilter
--------------------
.. autoclass:: aiogram.dispatcher.filters.builtin.RegexpCommandsFilter
.. autoclass:: aiogram.dispatcher.filters.RegexpCommandsFilter
:members:
:show-inheritance:
@ -90,21 +90,21 @@ RegexpCommandsFilter
ContentTypeFilter
-----------------
.. autoclass:: aiogram.dispatcher.filters.builtin.ContentTypeFilter
.. autoclass:: aiogram.dispatcher.filters.ContentTypeFilter
:members:
:show-inheritance:
IsSenderContact
---------------
.. autoclass:: aiogram.dispatcher.filters.builtin.IsSenderContact
.. autoclass:: aiogram.dispatcher.filters.IsSenderContact
:members:
:show-inheritance:
StateFilter
-----------
.. autoclass:: aiogram.dispatcher.filters.builtin.StateFilter
.. autoclass:: aiogram.dispatcher.filters.StateFilter
:members:
:show-inheritance:
@ -112,13 +112,13 @@ StateFilter
ExceptionsFilter
----------------
.. autoclass:: aiogram.dispatcher.filters.builtin.ExceptionsFilter
.. autoclass:: aiogram.dispatcher.filters.ExceptionsFilter
:members:
:show-inheritance:
IDFilter
----------------
--------
.. autoclass:: aiogram.dispatcher.filters.builtin.IDFilter
:members:
@ -126,9 +126,9 @@ IDFilter
AdminFilter
----------------
-----------
.. autoclass:: aiogram.dispatcher.filters.builtin.AdminFilter
.. autoclass:: aiogram.dispatcher.filters.AdminFilter
:members:
:show-inheritance:
@ -136,23 +136,23 @@ AdminFilter
IsReplyFilter
-------------
.. autoclass:: aiogram.dispatcher.filters.filters.IsReplyFilter
.. autoclass:: aiogram.dispatcher.filters.IsReplyFilter
:members:
:show-inheritance:
ForwardedMessageFilter
-------------
----------------------
.. autoclass:: aiogram.dispatcher.filters.filters.ForwardedMessageFilter
.. autoclass:: aiogram.dispatcher.filters.ForwardedMessageFilter
:members:
:show-inheritance:
ChatTypeFilter
-------------
--------------
.. autoclass:: aiogram.dispatcher.filters.filters.ChatTypeFilter
.. autoclass:: aiogram.dispatcher.filters.ChatTypeFilter
:members:
:show-inheritance:
@ -170,19 +170,19 @@ Own filter can be:
AbstractFilter
--------------
.. autoclass:: aiogram.dispatcher.filters.filters.AbstractFilter
.. autoclass:: aiogram.dispatcher.filters.AbstractFilter
:members:
:show-inheritance:
Filter
------
.. autoclass:: aiogram.dispatcher.filters.filters.Filter
.. autoclass:: aiogram.dispatcher.filters.Filter
:members:
:show-inheritance:
BoundFilter
-----------
.. autoclass:: aiogram.dispatcher.filters.filters.BoundFilter
.. autoclass:: aiogram.dispatcher.filters.BoundFilter
:members:
:show-inheritance:

20
docs/source/dispatcher/fsm.rst
View file

@ -12,15 +12,29 @@ Coming soon...
Memory storage
~~~~~~~~~~~~~~
Coming soon...
.. autoclass:: aiogram.contrib.fsm_storage.memory.MemoryStorage
:show-inheritance:
Redis storage
~~~~~~~~~~~~~
Coming soon...
.. autoclass:: aiogram.contrib.fsm_storage.redis.RedisStorage
:show-inheritance:
Mongo storage
~~~~~~~~~~~~~
.. autoclass:: aiogram.contrib.fsm_storage.mongo.MongoStorage
:show-inheritance:
Rethink DB storage
~~~~~~~~~~~~~~~~~~
Coming soon...
.. autoclass:: aiogram.contrib.fsm_storage.rethinkdb.RethinkDBStorage
:show-inheritance:
Making own storage's
~~~~~~~~~~~~~~~~~~~~

4
docs/source/examples/throtling_example.rst
View file

@ -7,8 +7,8 @@ Throtling example
Example for throttling manager.
You can use that for flood controlling.
.. literalinclude:: ../../../examples/throtling_example.py
:caption: throtling_example.py
.. literalinclude:: ../../../examples/throttling_example.py
:caption: throttling_example.py
:language: python
:linenos:
:lines: 7-

8
docs/source/examples/webhook_example_2.rst
View file

@ -1,10 +1,10 @@
.. Autogenerated file at 2018-09-08 02:07:37.576034
=================
Webhook example 2
=================
===================
Webhook example old
===================
.. literalinclude:: ../../../examples/webhook_example_2.py
.. literalinclude:: ../../../examples/webhook_example_old.py
:caption: webhook_example_2.py
:language: python
:linenos:

1
docs/source/utils/index.rst
View file

@ -13,3 +13,4 @@ Utils
parts
json
emoji
deep_linking