diff --git a/.gitignore b/.gitignore index e4189c4f..1f3e1971 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .idea/ +.vscode/ __pycache__/ *.py[cod] diff --git a/aiogram/dispatcher/event/event.py b/aiogram/dispatcher/event/event.py index 29aa4580..ef87d329 100644 --- a/aiogram/dispatcher/event/event.py +++ b/aiogram/dispatcher/event/event.py @@ -8,6 +8,19 @@ from .handler import CallbackType, HandlerObject, HandlerType class EventObserver: """ Simple events observer + + Is used for managing events is not related with Telegram (For example startup/shutdown processes) + + Handlers can be registered via decorator or method + + .. code-block:: python + + .register(my_handler) + + .. code-block:: python + + @() + async def my_handler(*args, **kwargs): ... """ def __init__(self) -> None: diff --git a/aiogram/dispatcher/event/telegram.py b/aiogram/dispatcher/event/telegram.py index e72d5db3..00164856 100644 --- a/aiogram/dispatcher/event/telegram.py +++ b/aiogram/dispatcher/event/telegram.py @@ -18,6 +18,9 @@ if TYPE_CHECKING: # pragma: no cover class TelegramEventObserver: """ Event observer for Telegram events + + Here you can register handler with filters or bounded filters which can be used as keyword arguments instead of writing full references when you register new handlers. + This observer will stops event propagation when first handler is pass. """ def __init__(self, router: Router, event_name: str) -> None: @@ -153,10 +156,19 @@ class TelegramEventObserver: Decorator for registering inner middlewares Usage: - >>> @.middleware() # via decorator (variant 1) - >>> @.middleware # via decorator (variant 2) - >>> async def my_middleware(handler, event, data): ... - >>> .middleware(middleware) # via method + + .. code-block:: python + + @.middleware() # via decorator (variant 1) + + .. code-block:: python + + @.middleware # via decorator (variant 2) + + .. code-block:: python + + async def my_middleware(handler, event, data): ... + .middleware(my_middleware) # via method """ def wrapper(m: MiddlewareType) -> MiddlewareType: @@ -174,10 +186,19 @@ class TelegramEventObserver: Decorator for registering outer middlewares Usage: - >>> @.outer_middleware() # via decorator (variant 1) - >>> @.outer_middleware # via decorator (variant 2) - >>> async def my_middleware(handler, event, data): ... - >>> .outer_middleware(my_middleware) # via method + + .. code-block:: python + + @.outer_middleware() # via decorator (variant 1) + + .. code-block:: python + + @.outer_middleware # via decorator (variant 2) + + .. code-block:: python + + async def my_middleware(handler, event, data): ... + .outer_middleware(my_middleware) # via method """ def wrapper(m: MiddlewareType) -> MiddlewareType: diff --git a/aiogram/dispatcher/router.py b/aiogram/dispatcher/router.py index 7680454e..641b293d 100644 --- a/aiogram/dispatcher/router.py +++ b/aiogram/dispatcher/router.py @@ -15,10 +15,22 @@ from .middlewares.error import ErrorsMiddleware class Router: """ - Events router + Router can route update and it nested update types like messages, callback query, polls and all other event types. + Here is used event-observer pattern. + + Event handlers can be registered in observer by two ways: + + - By observer method - :obj:`router..register(handler, )` + - By decorator - :obj:`@router.()` + """ def __init__(self, use_builtin_filters: bool = True) -> None: + """ + + :param use_builtin_filters: `aiogram` has many builtin filters and you can controll automatic registration of this filters in factory + """ + self.use_builtin_filters = use_builtin_filters self._parent_router: Optional[Router] = None diff --git a/docs2/Makefile b/docs2/Makefile index 84ae0cb1..f48952a6 100644 --- a/docs2/Makefile +++ b/docs2/Makefile @@ -6,7 +6,7 @@ SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SPHINXINTL ?= sphinx-intl -SOURCEDIR = source +SOURCEDIR = . BUILDDIR = _build # Put it first so that "make" without argument is like "make help". diff --git a/docs2/_static/basics_middleware.png b/docs2/_static/basics_middleware.png new file mode 100644 index 00000000..b4165e2e Binary files /dev/null and b/docs2/_static/basics_middleware.png differ diff --git a/docs2/source/_static/logo.png b/docs2/_static/logo.png similarity index 100% rename from docs2/source/_static/logo.png rename to docs2/_static/logo.png diff --git a/docs2/_static/middleware_pipeline.png b/docs2/_static/middleware_pipeline.png new file mode 100644 index 00000000..dcb20d6f Binary files /dev/null and b/docs2/_static/middleware_pipeline.png differ diff --git a/docs2/_static/middleware_pipeline_nested.png b/docs2/_static/middleware_pipeline_nested.png new file mode 100644 index 00000000..f7a6195a Binary files /dev/null and b/docs2/_static/middleware_pipeline_nested.png differ diff --git a/docs2/_static/nested_routers_example.png b/docs2/_static/nested_routers_example.png new file mode 100644 index 00000000..8ccd824f Binary files /dev/null and b/docs2/_static/nested_routers_example.png differ diff --git a/docs2/_static/update_propagation_flow.png b/docs2/_static/update_propagation_flow.png new file mode 100644 index 00000000..1bd3667f Binary files /dev/null and b/docs2/_static/update_propagation_flow.png differ diff --git a/docs2/source/api/bot.rst b/docs2/api/bot.rst similarity index 84% rename from docs2/source/api/bot.rst rename to docs2/api/bot.rst index a29ad6b1..9f40aca1 100644 --- a/docs2/source/api/bot.rst +++ b/docs2/api/bot.rst @@ -12,3 +12,6 @@ For example :code:`sendMessage` named :code:`send_message` and has the same spec .. autoclass:: aiogram.api.client.bot.Bot :members: :show-inheritance: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/download_file.rst b/docs2/api/download_file.rst similarity index 100% rename from docs2/source/api/download_file.rst rename to docs2/api/download_file.rst diff --git a/docs2/source/api/index.rst b/docs2/api/index.rst similarity index 100% rename from docs2/source/api/index.rst rename to docs2/api/index.rst diff --git a/docs2/source/api/methods/add_sticker_to_set.rst b/docs2/api/methods/add_sticker_to_set.rst similarity index 93% rename from docs2/source/api/methods/add_sticker_to_set.rst rename to docs2/api/methods/add_sticker_to_set.rst index 0519f5ea..82d4f454 100644 --- a/docs2/source/api/methods/add_sticker_to_set.rst +++ b/docs2/api/methods/add_sticker_to_set.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.add_sticker_to_set :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/answer_callback_query.rst b/docs2/api/methods/answer_callback_query.rst similarity index 94% rename from docs2/source/api/methods/answer_callback_query.rst rename to docs2/api/methods/answer_callback_query.rst index 4349a473..d0c602cd 100644 --- a/docs2/source/api/methods/answer_callback_query.rst +++ b/docs2/api/methods/answer_callback_query.rst @@ -10,6 +10,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.answer_callback_query :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/answer_inline_query.rst b/docs2/api/methods/answer_inline_query.rst similarity index 92% rename from docs2/source/api/methods/answer_inline_query.rst rename to docs2/api/methods/answer_inline_query.rst index 52490884..09040291 100644 --- a/docs2/source/api/methods/answer_inline_query.rst +++ b/docs2/api/methods/answer_inline_query.rst @@ -10,6 +10,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.answer_inline_query :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/answer_pre_checkout_query.rst b/docs2/api/methods/answer_pre_checkout_query.rst similarity index 93% rename from docs2/source/api/methods/answer_pre_checkout_query.rst rename to docs2/api/methods/answer_pre_checkout_query.rst index 3ac039a4..9809bc67 100644 --- a/docs2/source/api/methods/answer_pre_checkout_query.rst +++ b/docs2/api/methods/answer_pre_checkout_query.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.answer_pre_checkout_query :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/answer_shipping_query.rst b/docs2/api/methods/answer_shipping_query.rst similarity index 93% rename from docs2/source/api/methods/answer_shipping_query.rst rename to docs2/api/methods/answer_shipping_query.rst index 2753e0eb..35ce6199 100644 --- a/docs2/source/api/methods/answer_shipping_query.rst +++ b/docs2/api/methods/answer_shipping_query.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.answer_shipping_query :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/create_new_sticker_set.rst b/docs2/api/methods/create_new_sticker_set.rst similarity index 92% rename from docs2/source/api/methods/create_new_sticker_set.rst rename to docs2/api/methods/create_new_sticker_set.rst index 8b272364..70d98636 100644 --- a/docs2/source/api/methods/create_new_sticker_set.rst +++ b/docs2/api/methods/create_new_sticker_set.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.create_new_sticker_set :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/delete_chat_photo.rst b/docs2/api/methods/delete_chat_photo.rst similarity index 92% rename from docs2/source/api/methods/delete_chat_photo.rst rename to docs2/api/methods/delete_chat_photo.rst index e71493e2..209f4752 100644 --- a/docs2/source/api/methods/delete_chat_photo.rst +++ b/docs2/api/methods/delete_chat_photo.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.delete_chat_photo :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/delete_chat_sticker_set.rst b/docs2/api/methods/delete_chat_sticker_set.rst similarity index 93% rename from docs2/source/api/methods/delete_chat_sticker_set.rst rename to docs2/api/methods/delete_chat_sticker_set.rst index a6cbef1f..7385050e 100644 --- a/docs2/source/api/methods/delete_chat_sticker_set.rst +++ b/docs2/api/methods/delete_chat_sticker_set.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.delete_chat_sticker_set :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/delete_message.rst b/docs2/api/methods/delete_message.rst similarity index 94% rename from docs2/source/api/methods/delete_message.rst rename to docs2/api/methods/delete_message.rst index e030fdb7..41ebaee4 100644 --- a/docs2/source/api/methods/delete_message.rst +++ b/docs2/api/methods/delete_message.rst @@ -24,6 +24,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.delete_message :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/delete_sticker_from_set.rst b/docs2/api/methods/delete_sticker_from_set.rst similarity index 92% rename from docs2/source/api/methods/delete_sticker_from_set.rst rename to docs2/api/methods/delete_sticker_from_set.rst index aa4dbb84..80daaa16 100644 --- a/docs2/source/api/methods/delete_sticker_from_set.rst +++ b/docs2/api/methods/delete_sticker_from_set.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.delete_sticker_from_set :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/delete_webhook.rst b/docs2/api/methods/delete_webhook.rst similarity index 91% rename from docs2/source/api/methods/delete_webhook.rst rename to docs2/api/methods/delete_webhook.rst index 2344f5a2..ddf0c126 100644 --- a/docs2/source/api/methods/delete_webhook.rst +++ b/docs2/api/methods/delete_webhook.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.delete_webhook :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/edit_message_caption.rst b/docs2/api/methods/edit_message_caption.rst similarity index 92% rename from docs2/source/api/methods/edit_message_caption.rst rename to docs2/api/methods/edit_message_caption.rst index 82c47c77..0ee58b74 100644 --- a/docs2/source/api/methods/edit_message_caption.rst +++ b/docs2/api/methods/edit_message_caption.rst @@ -8,6 +8,9 @@ Returns: :obj:`Union[Message, bool]` .. automodule:: aiogram.api.methods.edit_message_caption :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/edit_message_live_location.rst b/docs2/api/methods/edit_message_live_location.rst similarity index 93% rename from docs2/source/api/methods/edit_message_live_location.rst rename to docs2/api/methods/edit_message_live_location.rst index e969b735..77ee05d0 100644 --- a/docs2/source/api/methods/edit_message_live_location.rst +++ b/docs2/api/methods/edit_message_live_location.rst @@ -8,6 +8,9 @@ Returns: :obj:`Union[Message, bool]` .. automodule:: aiogram.api.methods.edit_message_live_location :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/edit_message_media.rst b/docs2/api/methods/edit_message_media.rst similarity index 94% rename from docs2/source/api/methods/edit_message_media.rst rename to docs2/api/methods/edit_message_media.rst index e6b4a1f4..ed376534 100644 --- a/docs2/source/api/methods/edit_message_media.rst +++ b/docs2/api/methods/edit_message_media.rst @@ -8,6 +8,9 @@ Returns: :obj:`Union[Message, bool]` .. automodule:: aiogram.api.methods.edit_message_media :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/edit_message_reply_markup.rst b/docs2/api/methods/edit_message_reply_markup.rst similarity index 93% rename from docs2/source/api/methods/edit_message_reply_markup.rst rename to docs2/api/methods/edit_message_reply_markup.rst index 22527d69..fcee14f0 100644 --- a/docs2/source/api/methods/edit_message_reply_markup.rst +++ b/docs2/api/methods/edit_message_reply_markup.rst @@ -8,6 +8,9 @@ Returns: :obj:`Union[Message, bool]` .. automodule:: aiogram.api.methods.edit_message_reply_markup :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/edit_message_text.rst b/docs2/api/methods/edit_message_text.rst similarity index 92% rename from docs2/source/api/methods/edit_message_text.rst rename to docs2/api/methods/edit_message_text.rst index 74230ee2..af456971 100644 --- a/docs2/source/api/methods/edit_message_text.rst +++ b/docs2/api/methods/edit_message_text.rst @@ -8,6 +8,9 @@ Returns: :obj:`Union[Message, bool]` .. automodule:: aiogram.api.methods.edit_message_text :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/export_chat_invite_link.rst b/docs2/api/methods/export_chat_invite_link.rst similarity index 94% rename from docs2/source/api/methods/export_chat_invite_link.rst rename to docs2/api/methods/export_chat_invite_link.rst index 089b7d8f..a5ed0f04 100644 --- a/docs2/source/api/methods/export_chat_invite_link.rst +++ b/docs2/api/methods/export_chat_invite_link.rst @@ -10,6 +10,9 @@ Returns: :obj:`str` .. automodule:: aiogram.api.methods.export_chat_invite_link :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/forward_message.rst b/docs2/api/methods/forward_message.rst similarity index 91% rename from docs2/source/api/methods/forward_message.rst rename to docs2/api/methods/forward_message.rst index 285d0f4d..443c4b5d 100644 --- a/docs2/source/api/methods/forward_message.rst +++ b/docs2/api/methods/forward_message.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.forward_message :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_chat.rst b/docs2/api/methods/get_chat.rst similarity index 90% rename from docs2/source/api/methods/get_chat.rst rename to docs2/api/methods/get_chat.rst index 02e115ee..e9a3101c 100644 --- a/docs2/source/api/methods/get_chat.rst +++ b/docs2/api/methods/get_chat.rst @@ -8,6 +8,9 @@ Returns: :obj:`Chat` .. automodule:: aiogram.api.methods.get_chat :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_chat_administrators.rst b/docs2/api/methods/get_chat_administrators.rst similarity index 93% rename from docs2/source/api/methods/get_chat_administrators.rst rename to docs2/api/methods/get_chat_administrators.rst index 01da98e8..5c10491f 100644 --- a/docs2/source/api/methods/get_chat_administrators.rst +++ b/docs2/api/methods/get_chat_administrators.rst @@ -8,6 +8,9 @@ Returns: :obj:`List[ChatMember]` .. automodule:: aiogram.api.methods.get_chat_administrators :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_chat_member.rst b/docs2/api/methods/get_chat_member.rst similarity index 90% rename from docs2/source/api/methods/get_chat_member.rst rename to docs2/api/methods/get_chat_member.rst index 07f8025b..07d53460 100644 --- a/docs2/source/api/methods/get_chat_member.rst +++ b/docs2/api/methods/get_chat_member.rst @@ -8,6 +8,9 @@ Returns: :obj:`ChatMember` .. automodule:: aiogram.api.methods.get_chat_member :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_chat_members_count.rst b/docs2/api/methods/get_chat_members_count.rst similarity index 90% rename from docs2/source/api/methods/get_chat_members_count.rst rename to docs2/api/methods/get_chat_members_count.rst index 84c50d75..4cd69f66 100644 --- a/docs2/source/api/methods/get_chat_members_count.rst +++ b/docs2/api/methods/get_chat_members_count.rst @@ -8,6 +8,9 @@ Returns: :obj:`int` .. automodule:: aiogram.api.methods.get_chat_members_count :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_file.rst b/docs2/api/methods/get_file.rst similarity index 93% rename from docs2/source/api/methods/get_file.rst rename to docs2/api/methods/get_file.rst index a3ba84b4..cc40a00b 100644 --- a/docs2/source/api/methods/get_file.rst +++ b/docs2/api/methods/get_file.rst @@ -10,6 +10,9 @@ Returns: :obj:`File` .. automodule:: aiogram.api.methods.get_file :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_game_high_scores.rst b/docs2/api/methods/get_game_high_scores.rst similarity index 93% rename from docs2/source/api/methods/get_game_high_scores.rst rename to docs2/api/methods/get_game_high_scores.rst index 9326171e..e4171f55 100644 --- a/docs2/source/api/methods/get_game_high_scores.rst +++ b/docs2/api/methods/get_game_high_scores.rst @@ -10,6 +10,9 @@ Returns: :obj:`List[GameHighScore]` .. automodule:: aiogram.api.methods.get_game_high_scores :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_me.rst b/docs2/api/methods/get_me.rst similarity index 89% rename from docs2/source/api/methods/get_me.rst rename to docs2/api/methods/get_me.rst index a43f35cf..6d0fda74 100644 --- a/docs2/source/api/methods/get_me.rst +++ b/docs2/api/methods/get_me.rst @@ -8,6 +8,9 @@ Returns: :obj:`User` .. automodule:: aiogram.api.methods.get_me :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_my_commands.rst b/docs2/api/methods/get_my_commands.rst similarity index 91% rename from docs2/source/api/methods/get_my_commands.rst rename to docs2/api/methods/get_my_commands.rst index a228938d..103539e8 100644 --- a/docs2/source/api/methods/get_my_commands.rst +++ b/docs2/api/methods/get_my_commands.rst @@ -8,6 +8,9 @@ Returns: :obj:`List[BotCommand]` .. automodule:: aiogram.api.methods.get_my_commands :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_sticker_set.rst b/docs2/api/methods/get_sticker_set.rst similarity index 90% rename from docs2/source/api/methods/get_sticker_set.rst rename to docs2/api/methods/get_sticker_set.rst index 66d1c768..d7694f61 100644 --- a/docs2/source/api/methods/get_sticker_set.rst +++ b/docs2/api/methods/get_sticker_set.rst @@ -8,6 +8,9 @@ Returns: :obj:`StickerSet` .. automodule:: aiogram.api.methods.get_sticker_set :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_updates.rst b/docs2/api/methods/get_updates.rst similarity index 92% rename from docs2/source/api/methods/get_updates.rst rename to docs2/api/methods/get_updates.rst index 7204145d..068cd31a 100644 --- a/docs2/source/api/methods/get_updates.rst +++ b/docs2/api/methods/get_updates.rst @@ -14,6 +14,9 @@ Returns: :obj:`List[Update]` .. automodule:: aiogram.api.methods.get_updates :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_user_profile_photos.rst b/docs2/api/methods/get_user_profile_photos.rst similarity index 91% rename from docs2/source/api/methods/get_user_profile_photos.rst rename to docs2/api/methods/get_user_profile_photos.rst index 2f42d65f..ac68e32c 100644 --- a/docs2/source/api/methods/get_user_profile_photos.rst +++ b/docs2/api/methods/get_user_profile_photos.rst @@ -8,6 +8,9 @@ Returns: :obj:`UserProfilePhotos` .. automodule:: aiogram.api.methods.get_user_profile_photos :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/get_webhook_info.rst b/docs2/api/methods/get_webhook_info.rst similarity index 91% rename from docs2/source/api/methods/get_webhook_info.rst rename to docs2/api/methods/get_webhook_info.rst index 0534ff50..94381347 100644 --- a/docs2/source/api/methods/get_webhook_info.rst +++ b/docs2/api/methods/get_webhook_info.rst @@ -8,6 +8,9 @@ Returns: :obj:`WebhookInfo` .. automodule:: aiogram.api.methods.get_webhook_info :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/index.rst b/docs2/api/methods/index.rst similarity index 100% rename from docs2/source/api/methods/index.rst rename to docs2/api/methods/index.rst diff --git a/docs2/source/api/methods/kick_chat_member.rst b/docs2/api/methods/kick_chat_member.rst similarity index 93% rename from docs2/source/api/methods/kick_chat_member.rst rename to docs2/api/methods/kick_chat_member.rst index 0a3247b9..14bceb76 100644 --- a/docs2/source/api/methods/kick_chat_member.rst +++ b/docs2/api/methods/kick_chat_member.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.kick_chat_member :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/leave_chat.rst b/docs2/api/methods/leave_chat.rst similarity index 91% rename from docs2/source/api/methods/leave_chat.rst rename to docs2/api/methods/leave_chat.rst index 13c802a0..c8497475 100644 --- a/docs2/source/api/methods/leave_chat.rst +++ b/docs2/api/methods/leave_chat.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.leave_chat :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/pin_chat_message.rst b/docs2/api/methods/pin_chat_message.rst similarity index 92% rename from docs2/source/api/methods/pin_chat_message.rst rename to docs2/api/methods/pin_chat_message.rst index 189e4d8f..60728235 100644 --- a/docs2/source/api/methods/pin_chat_message.rst +++ b/docs2/api/methods/pin_chat_message.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.pin_chat_message :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/promote_chat_member.rst b/docs2/api/methods/promote_chat_member.rst similarity index 93% rename from docs2/source/api/methods/promote_chat_member.rst rename to docs2/api/methods/promote_chat_member.rst index 3d039656..4cbbb89d 100644 --- a/docs2/source/api/methods/promote_chat_member.rst +++ b/docs2/api/methods/promote_chat_member.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.promote_chat_member :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/restrict_chat_member.rst b/docs2/api/methods/restrict_chat_member.rst similarity index 93% rename from docs2/source/api/methods/restrict_chat_member.rst rename to docs2/api/methods/restrict_chat_member.rst index 6210a1a6..7b7fe121 100644 --- a/docs2/source/api/methods/restrict_chat_member.rst +++ b/docs2/api/methods/restrict_chat_member.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.restrict_chat_member :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_animation.rst b/docs2/api/methods/send_animation.rst similarity index 92% rename from docs2/source/api/methods/send_animation.rst rename to docs2/api/methods/send_animation.rst index 471d518d..a26c41fa 100644 --- a/docs2/source/api/methods/send_animation.rst +++ b/docs2/api/methods/send_animation.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_animation :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_audio.rst b/docs2/api/methods/send_audio.rst similarity index 93% rename from docs2/source/api/methods/send_audio.rst rename to docs2/api/methods/send_audio.rst index d80df3f3..7c797c4f 100644 --- a/docs2/source/api/methods/send_audio.rst +++ b/docs2/api/methods/send_audio.rst @@ -10,6 +10,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_audio :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_chat_action.rst b/docs2/api/methods/send_chat_action.rst similarity index 94% rename from docs2/source/api/methods/send_chat_action.rst rename to docs2/api/methods/send_chat_action.rst index 5a0b4516..a2ad32c7 100644 --- a/docs2/source/api/methods/send_chat_action.rst +++ b/docs2/api/methods/send_chat_action.rst @@ -12,6 +12,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.send_chat_action :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_contact.rst b/docs2/api/methods/send_contact.rst similarity index 91% rename from docs2/source/api/methods/send_contact.rst rename to docs2/api/methods/send_contact.rst index 7bce0f54..df912679 100644 --- a/docs2/source/api/methods/send_contact.rst +++ b/docs2/api/methods/send_contact.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_contact :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_dice.rst b/docs2/api/methods/send_dice.rst similarity index 91% rename from docs2/source/api/methods/send_dice.rst rename to docs2/api/methods/send_dice.rst index 2226db47..f58b410e 100644 --- a/docs2/source/api/methods/send_dice.rst +++ b/docs2/api/methods/send_dice.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_dice :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_document.rst b/docs2/api/methods/send_document.rst similarity index 92% rename from docs2/source/api/methods/send_document.rst rename to docs2/api/methods/send_document.rst index 9ceeffdc..afa2de3e 100644 --- a/docs2/source/api/methods/send_document.rst +++ b/docs2/api/methods/send_document.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_document :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_game.rst b/docs2/api/methods/send_game.rst similarity index 90% rename from docs2/source/api/methods/send_game.rst rename to docs2/api/methods/send_game.rst index 73ca2a6a..efad6f68 100644 --- a/docs2/source/api/methods/send_game.rst +++ b/docs2/api/methods/send_game.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_game :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_invoice.rst b/docs2/api/methods/send_invoice.rst similarity index 91% rename from docs2/source/api/methods/send_invoice.rst rename to docs2/api/methods/send_invoice.rst index 41d94cbd..5409b2ec 100644 --- a/docs2/source/api/methods/send_invoice.rst +++ b/docs2/api/methods/send_invoice.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_invoice :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_location.rst b/docs2/api/methods/send_location.rst similarity index 91% rename from docs2/source/api/methods/send_location.rst rename to docs2/api/methods/send_location.rst index d7ecbd2d..5410e967 100644 --- a/docs2/source/api/methods/send_location.rst +++ b/docs2/api/methods/send_location.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_location :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_media_group.rst b/docs2/api/methods/send_media_group.rst similarity index 92% rename from docs2/source/api/methods/send_media_group.rst rename to docs2/api/methods/send_media_group.rst index d7557e51..85c748cd 100644 --- a/docs2/source/api/methods/send_media_group.rst +++ b/docs2/api/methods/send_media_group.rst @@ -8,6 +8,9 @@ Returns: :obj:`List[Message]` .. automodule:: aiogram.api.methods.send_media_group :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_message.rst b/docs2/api/methods/send_message.rst similarity index 91% rename from docs2/source/api/methods/send_message.rst rename to docs2/api/methods/send_message.rst index 263bc612..d17d9aaf 100644 --- a/docs2/source/api/methods/send_message.rst +++ b/docs2/api/methods/send_message.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_message :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_photo.rst b/docs2/api/methods/send_photo.rst similarity index 90% rename from docs2/source/api/methods/send_photo.rst rename to docs2/api/methods/send_photo.rst index 5ecee825..450bf9d8 100644 --- a/docs2/source/api/methods/send_photo.rst +++ b/docs2/api/methods/send_photo.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_photo :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_poll.rst b/docs2/api/methods/send_poll.rst similarity index 90% rename from docs2/source/api/methods/send_poll.rst rename to docs2/api/methods/send_poll.rst index 18812c64..9bc1f331 100644 --- a/docs2/source/api/methods/send_poll.rst +++ b/docs2/api/methods/send_poll.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_poll :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_sticker.rst b/docs2/api/methods/send_sticker.rst similarity index 91% rename from docs2/source/api/methods/send_sticker.rst rename to docs2/api/methods/send_sticker.rst index 686b6ebd..a52802ae 100644 --- a/docs2/source/api/methods/send_sticker.rst +++ b/docs2/api/methods/send_sticker.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_sticker :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_venue.rst b/docs2/api/methods/send_venue.rst similarity index 91% rename from docs2/source/api/methods/send_venue.rst rename to docs2/api/methods/send_venue.rst index 32ff21b5..2ae6fe74 100644 --- a/docs2/source/api/methods/send_venue.rst +++ b/docs2/api/methods/send_venue.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_venue :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_video.rst b/docs2/api/methods/send_video.rst similarity index 92% rename from docs2/source/api/methods/send_video.rst rename to docs2/api/methods/send_video.rst index 22695f7f..a896b554 100644 --- a/docs2/source/api/methods/send_video.rst +++ b/docs2/api/methods/send_video.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_video :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_video_note.rst b/docs2/api/methods/send_video_note.rst similarity index 92% rename from docs2/source/api/methods/send_video_note.rst rename to docs2/api/methods/send_video_note.rst index 71c2f777..e210564f 100644 --- a/docs2/source/api/methods/send_video_note.rst +++ b/docs2/api/methods/send_video_note.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_video_note :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/send_voice.rst b/docs2/api/methods/send_voice.rst similarity index 93% rename from docs2/source/api/methods/send_voice.rst rename to docs2/api/methods/send_voice.rst index 82b25060..a701d8ad 100644 --- a/docs2/source/api/methods/send_voice.rst +++ b/docs2/api/methods/send_voice.rst @@ -8,6 +8,9 @@ Returns: :obj:`Message` .. automodule:: aiogram.api.methods.send_voice :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_chat_administrator_custom_title.rst b/docs2/api/methods/set_chat_administrator_custom_title.rst similarity index 93% rename from docs2/source/api/methods/set_chat_administrator_custom_title.rst rename to docs2/api/methods/set_chat_administrator_custom_title.rst index 2997557b..432365c4 100644 --- a/docs2/source/api/methods/set_chat_administrator_custom_title.rst +++ b/docs2/api/methods/set_chat_administrator_custom_title.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_chat_administrator_custom_title :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_chat_description.rst b/docs2/api/methods/set_chat_description.rst similarity index 92% rename from docs2/source/api/methods/set_chat_description.rst rename to docs2/api/methods/set_chat_description.rst index faa8cb91..e5079324 100644 --- a/docs2/source/api/methods/set_chat_description.rst +++ b/docs2/api/methods/set_chat_description.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_chat_description :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_chat_permissions.rst b/docs2/api/methods/set_chat_permissions.rst similarity index 92% rename from docs2/source/api/methods/set_chat_permissions.rst rename to docs2/api/methods/set_chat_permissions.rst index 0b6c6030..e71a64ce 100644 --- a/docs2/source/api/methods/set_chat_permissions.rst +++ b/docs2/api/methods/set_chat_permissions.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_chat_permissions :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_chat_photo.rst b/docs2/api/methods/set_chat_photo.rst similarity index 91% rename from docs2/source/api/methods/set_chat_photo.rst rename to docs2/api/methods/set_chat_photo.rst index 2f9a4f89..fcfa8431 100644 --- a/docs2/source/api/methods/set_chat_photo.rst +++ b/docs2/api/methods/set_chat_photo.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_chat_photo :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_chat_sticker_set.rst b/docs2/api/methods/set_chat_sticker_set.rst similarity index 93% rename from docs2/source/api/methods/set_chat_sticker_set.rst rename to docs2/api/methods/set_chat_sticker_set.rst index ed52e70f..3d10066e 100644 --- a/docs2/source/api/methods/set_chat_sticker_set.rst +++ b/docs2/api/methods/set_chat_sticker_set.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_chat_sticker_set :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_chat_title.rst b/docs2/api/methods/set_chat_title.rst similarity index 92% rename from docs2/source/api/methods/set_chat_title.rst rename to docs2/api/methods/set_chat_title.rst index d4643377..99c08a3f 100644 --- a/docs2/source/api/methods/set_chat_title.rst +++ b/docs2/api/methods/set_chat_title.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_chat_title :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_game_score.rst b/docs2/api/methods/set_game_score.rst similarity index 93% rename from docs2/source/api/methods/set_game_score.rst rename to docs2/api/methods/set_game_score.rst index a64062ad..bf50b7c8 100644 --- a/docs2/source/api/methods/set_game_score.rst +++ b/docs2/api/methods/set_game_score.rst @@ -8,6 +8,9 @@ Returns: :obj:`Union[Message, bool]` .. automodule:: aiogram.api.methods.set_game_score :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_my_commands.rst b/docs2/api/methods/set_my_commands.rst similarity index 91% rename from docs2/source/api/methods/set_my_commands.rst rename to docs2/api/methods/set_my_commands.rst index 49e8e8cd..71a89a04 100644 --- a/docs2/source/api/methods/set_my_commands.rst +++ b/docs2/api/methods/set_my_commands.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_my_commands :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_passport_data_errors.rst b/docs2/api/methods/set_passport_data_errors.rst similarity index 94% rename from docs2/source/api/methods/set_passport_data_errors.rst rename to docs2/api/methods/set_passport_data_errors.rst index b34271c7..64b616d7 100644 --- a/docs2/source/api/methods/set_passport_data_errors.rst +++ b/docs2/api/methods/set_passport_data_errors.rst @@ -10,6 +10,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_passport_data_errors :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_sticker_position_in_set.rst b/docs2/api/methods/set_sticker_position_in_set.rst similarity index 92% rename from docs2/source/api/methods/set_sticker_position_in_set.rst rename to docs2/api/methods/set_sticker_position_in_set.rst index b5adf59d..ec1ed029 100644 --- a/docs2/source/api/methods/set_sticker_position_in_set.rst +++ b/docs2/api/methods/set_sticker_position_in_set.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_sticker_position_in_set :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_sticker_set_thumb.rst b/docs2/api/methods/set_sticker_set_thumb.rst similarity index 92% rename from docs2/source/api/methods/set_sticker_set_thumb.rst rename to docs2/api/methods/set_sticker_set_thumb.rst index 5dce98a8..97f5d130 100644 --- a/docs2/source/api/methods/set_sticker_set_thumb.rst +++ b/docs2/api/methods/set_sticker_set_thumb.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_sticker_set_thumb :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/set_webhook.rst b/docs2/api/methods/set_webhook.rst similarity index 95% rename from docs2/source/api/methods/set_webhook.rst rename to docs2/api/methods/set_webhook.rst index 9c05bbaf..38196ccf 100644 --- a/docs2/source/api/methods/set_webhook.rst +++ b/docs2/api/methods/set_webhook.rst @@ -20,6 +20,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.set_webhook :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/stop_message_live_location.rst b/docs2/api/methods/stop_message_live_location.rst similarity index 93% rename from docs2/source/api/methods/stop_message_live_location.rst rename to docs2/api/methods/stop_message_live_location.rst index 59646613..f5135490 100644 --- a/docs2/source/api/methods/stop_message_live_location.rst +++ b/docs2/api/methods/stop_message_live_location.rst @@ -8,6 +8,9 @@ Returns: :obj:`Union[Message, bool]` .. automodule:: aiogram.api.methods.stop_message_live_location :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/stop_poll.rst b/docs2/api/methods/stop_poll.rst similarity index 91% rename from docs2/source/api/methods/stop_poll.rst rename to docs2/api/methods/stop_poll.rst index 6fa81cdc..fcc4e019 100644 --- a/docs2/source/api/methods/stop_poll.rst +++ b/docs2/api/methods/stop_poll.rst @@ -8,6 +8,9 @@ Returns: :obj:`Poll` .. automodule:: aiogram.api.methods.stop_poll :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/unban_chat_member.rst b/docs2/api/methods/unban_chat_member.rst similarity index 92% rename from docs2/source/api/methods/unban_chat_member.rst rename to docs2/api/methods/unban_chat_member.rst index 8a4c78c9..89af3302 100644 --- a/docs2/source/api/methods/unban_chat_member.rst +++ b/docs2/api/methods/unban_chat_member.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.unban_chat_member :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/unpin_chat_message.rst b/docs2/api/methods/unpin_chat_message.rst similarity index 93% rename from docs2/source/api/methods/unpin_chat_message.rst rename to docs2/api/methods/unpin_chat_message.rst index cb2d82c4..d364453d 100644 --- a/docs2/source/api/methods/unpin_chat_message.rst +++ b/docs2/api/methods/unpin_chat_message.rst @@ -8,6 +8,9 @@ Returns: :obj:`bool` .. automodule:: aiogram.api.methods.unpin_chat_message :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/methods/upload_sticker_file.rst b/docs2/api/methods/upload_sticker_file.rst similarity index 91% rename from docs2/source/api/methods/upload_sticker_file.rst rename to docs2/api/methods/upload_sticker_file.rst index 158c8c52..03ad6d5a 100644 --- a/docs2/source/api/methods/upload_sticker_file.rst +++ b/docs2/api/methods/upload_sticker_file.rst @@ -8,6 +8,9 @@ Returns: :obj:`File` .. automodule:: aiogram.api.methods.upload_sticker_file :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True Usage diff --git a/docs2/source/api/session/aiohttp.rst b/docs2/api/session/aiohttp.rst similarity index 100% rename from docs2/source/api/session/aiohttp.rst rename to docs2/api/session/aiohttp.rst diff --git a/docs2/source/api/session/base.rst b/docs2/api/session/base.rst similarity index 100% rename from docs2/source/api/session/base.rst rename to docs2/api/session/base.rst diff --git a/docs2/source/api/session/index.rst b/docs2/api/session/index.rst similarity index 100% rename from docs2/source/api/session/index.rst rename to docs2/api/session/index.rst diff --git a/docs2/source/api/types/animation.rst b/docs2/api/types/animation.rst similarity index 68% rename from docs2/source/api/types/animation.rst rename to docs2/api/types/animation.rst index 5092d554..5e140064 100644 --- a/docs2/source/api/types/animation.rst +++ b/docs2/api/types/animation.rst @@ -6,3 +6,6 @@ This object represents an animation file (GIF or H.264/MPEG-4 AVC video without .. automodule:: aiogram.api.types.animation :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/audio.rst b/docs2/api/types/audio.rst similarity index 65% rename from docs2/source/api/types/audio.rst rename to docs2/api/types/audio.rst index 403e5e48..5ddc7047 100644 --- a/docs2/source/api/types/audio.rst +++ b/docs2/api/types/audio.rst @@ -6,3 +6,6 @@ This object represents an audio file to be treated as music by the Telegram clie .. automodule:: aiogram.api.types.audio :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/bot_command.rst b/docs2/api/types/bot_command.rst similarity index 61% rename from docs2/source/api/types/bot_command.rst rename to docs2/api/types/bot_command.rst index 06f5014f..f33cda94 100644 --- a/docs2/source/api/types/bot_command.rst +++ b/docs2/api/types/bot_command.rst @@ -6,3 +6,6 @@ This object represents a bot command. .. automodule:: aiogram.api.types.bot_command :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/callback_game.rst b/docs2/api/types/callback_game.rst similarity index 69% rename from docs2/source/api/types/callback_game.rst rename to docs2/api/types/callback_game.rst index 22ab736b..9cb6565f 100644 --- a/docs2/source/api/types/callback_game.rst +++ b/docs2/api/types/callback_game.rst @@ -6,3 +6,6 @@ A placeholder, currently holds no information. Use BotFather to set up your game .. automodule:: aiogram.api.types.callback_game :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/callback_query.rst b/docs2/api/types/callback_query.rst similarity index 90% rename from docs2/source/api/types/callback_query.rst rename to docs2/api/types/callback_query.rst index cb0c33f0..6ef622d1 100644 --- a/docs2/source/api/types/callback_query.rst +++ b/docs2/api/types/callback_query.rst @@ -8,3 +8,6 @@ NOTE: After the user presses a callback button, Telegram clients will display a .. automodule:: aiogram.api.types.callback_query :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/chat.rst b/docs2/api/types/chat.rst similarity index 54% rename from docs2/source/api/types/chat.rst rename to docs2/api/types/chat.rst index fa14e540..04240ef5 100644 --- a/docs2/source/api/types/chat.rst +++ b/docs2/api/types/chat.rst @@ -6,3 +6,6 @@ This object represents a chat. .. automodule:: aiogram.api.types.chat :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/chat_member.rst b/docs2/api/types/chat_member.rst similarity index 65% rename from docs2/source/api/types/chat_member.rst rename to docs2/api/types/chat_member.rst index eeef4b6f..10bcf77f 100644 --- a/docs2/source/api/types/chat_member.rst +++ b/docs2/api/types/chat_member.rst @@ -6,3 +6,6 @@ This object contains information about one member of a chat. .. automodule:: aiogram.api.types.chat_member :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/chat_permissions.rst b/docs2/api/types/chat_permissions.rst similarity index 69% rename from docs2/source/api/types/chat_permissions.rst rename to docs2/api/types/chat_permissions.rst index 7eff2cf5..37f611e9 100644 --- a/docs2/source/api/types/chat_permissions.rst +++ b/docs2/api/types/chat_permissions.rst @@ -6,3 +6,6 @@ Describes actions that a non-administrator user is allowed to take in a chat. .. automodule:: aiogram.api.types.chat_permissions :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/chat_photo.rst b/docs2/api/types/chat_photo.rst similarity index 60% rename from docs2/source/api/types/chat_photo.rst rename to docs2/api/types/chat_photo.rst index 00f4d65f..74ab833c 100644 --- a/docs2/source/api/types/chat_photo.rst +++ b/docs2/api/types/chat_photo.rst @@ -6,3 +6,6 @@ This object represents a chat photo. .. automodule:: aiogram.api.types.chat_photo :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/chosen_inline_result.rst b/docs2/api/types/chosen_inline_result.rst similarity index 80% rename from docs2/source/api/types/chosen_inline_result.rst rename to docs2/api/types/chosen_inline_result.rst index 943731af..699ffb60 100644 --- a/docs2/source/api/types/chosen_inline_result.rst +++ b/docs2/api/types/chosen_inline_result.rst @@ -8,3 +8,6 @@ Note: It is necessary to enable inline feedback via @Botfather in order to recei .. automodule:: aiogram.api.types.chosen_inline_result :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/contact.rst b/docs2/api/types/contact.rst similarity index 59% rename from docs2/source/api/types/contact.rst rename to docs2/api/types/contact.rst index dbde7bcf..32d63abf 100644 --- a/docs2/source/api/types/contact.rst +++ b/docs2/api/types/contact.rst @@ -6,3 +6,6 @@ This object represents a phone contact. .. automodule:: aiogram.api.types.contact :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/dice.rst b/docs2/api/types/dice.rst similarity index 62% rename from docs2/source/api/types/dice.rst rename to docs2/api/types/dice.rst index 90450051..5bfc1a91 100644 --- a/docs2/source/api/types/dice.rst +++ b/docs2/api/types/dice.rst @@ -6,3 +6,6 @@ This object represents an animated emoji that displays a random value. .. automodule:: aiogram.api.types.dice :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/document.rst b/docs2/api/types/document.rst similarity index 68% rename from docs2/source/api/types/document.rst rename to docs2/api/types/document.rst index fe497113..6f68e824 100644 --- a/docs2/source/api/types/document.rst +++ b/docs2/api/types/document.rst @@ -6,3 +6,6 @@ This object represents a general file (as opposed to photos, voice messages and .. automodule:: aiogram.api.types.document :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/encrypted_credentials.rst b/docs2/api/types/encrypted_credentials.rst similarity index 80% rename from docs2/source/api/types/encrypted_credentials.rst rename to docs2/api/types/encrypted_credentials.rst index 08bff496..fd05f0a7 100644 --- a/docs2/source/api/types/encrypted_credentials.rst +++ b/docs2/api/types/encrypted_credentials.rst @@ -6,3 +6,6 @@ Contains data required for decrypting and authenticating EncryptedPassportElemen .. automodule:: aiogram.api.types.encrypted_credentials :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/encrypted_passport_element.rst b/docs2/api/types/encrypted_passport_element.rst similarity index 75% rename from docs2/source/api/types/encrypted_passport_element.rst rename to docs2/api/types/encrypted_passport_element.rst index 3e187d57..c0e246d2 100644 --- a/docs2/source/api/types/encrypted_passport_element.rst +++ b/docs2/api/types/encrypted_passport_element.rst @@ -6,3 +6,6 @@ Contains information about documents or other Telegram Passport elements shared .. automodule:: aiogram.api.types.encrypted_passport_element :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/file.rst b/docs2/api/types/file.rst similarity index 82% rename from docs2/source/api/types/file.rst rename to docs2/api/types/file.rst index baa7c2de..b33c628b 100644 --- a/docs2/source/api/types/file.rst +++ b/docs2/api/types/file.rst @@ -8,3 +8,6 @@ Maximum file size to download is 20 MB .. automodule:: aiogram.api.types.file :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/force_reply.rst b/docs2/api/types/force_reply.rst similarity index 93% rename from docs2/source/api/types/force_reply.rst rename to docs2/api/types/force_reply.rst index 8fa98336..66622713 100644 --- a/docs2/source/api/types/force_reply.rst +++ b/docs2/api/types/force_reply.rst @@ -16,3 +16,6 @@ The last option is definitely more attractive. And if you use ForceReply in your .. automodule:: aiogram.api.types.force_reply :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/game.rst b/docs2/api/types/game.rst similarity index 69% rename from docs2/source/api/types/game.rst rename to docs2/api/types/game.rst index ad9095c2..e443ff2a 100644 --- a/docs2/source/api/types/game.rst +++ b/docs2/api/types/game.rst @@ -6,3 +6,6 @@ This object represents a game. Use BotFather to create and edit games, their sho .. automodule:: aiogram.api.types.game :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/game_high_score.rst b/docs2/api/types/game_high_score.rst similarity index 76% rename from docs2/source/api/types/game_high_score.rst rename to docs2/api/types/game_high_score.rst index 8551d3be..b8453d01 100644 --- a/docs2/source/api/types/game_high_score.rst +++ b/docs2/api/types/game_high_score.rst @@ -10,3 +10,6 @@ If you've got any questions, please check out our Bot FAQ .. automodule:: aiogram.api.types.game_high_score :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/index.rst b/docs2/api/types/index.rst similarity index 100% rename from docs2/source/api/types/index.rst rename to docs2/api/types/index.rst diff --git a/docs2/source/api/types/inline_keyboard_button.rst b/docs2/api/types/inline_keyboard_button.rst similarity index 74% rename from docs2/source/api/types/inline_keyboard_button.rst rename to docs2/api/types/inline_keyboard_button.rst index 62d7118d..d7b78e8e 100644 --- a/docs2/source/api/types/inline_keyboard_button.rst +++ b/docs2/api/types/inline_keyboard_button.rst @@ -6,3 +6,6 @@ This object represents one button of an inline keyboard. You must use exactly on .. automodule:: aiogram.api.types.inline_keyboard_button :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_keyboard_markup.rst b/docs2/api/types/inline_keyboard_markup.rst similarity index 81% rename from docs2/source/api/types/inline_keyboard_markup.rst rename to docs2/api/types/inline_keyboard_markup.rst index 56d4ca31..7641ae0a 100644 --- a/docs2/source/api/types/inline_keyboard_markup.rst +++ b/docs2/api/types/inline_keyboard_markup.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old .. automodule:: aiogram.api.types.inline_keyboard_markup :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query.rst b/docs2/api/types/inline_query.rst similarity index 74% rename from docs2/source/api/types/inline_query.rst rename to docs2/api/types/inline_query.rst index 4ba13dc5..f9f66111 100644 --- a/docs2/source/api/types/inline_query.rst +++ b/docs2/api/types/inline_query.rst @@ -6,3 +6,6 @@ This object represents an incoming inline query. When the user sends an empty qu .. automodule:: aiogram.api.types.inline_query :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result.rst b/docs2/api/types/inline_query_result.rst similarity index 91% rename from docs2/source/api/types/inline_query_result.rst rename to docs2/api/types/inline_query_result.rst index c798f40e..bfc571ef 100644 --- a/docs2/source/api/types/inline_query_result.rst +++ b/docs2/api/types/inline_query_result.rst @@ -46,3 +46,6 @@ This object represents one result of an inline query. Telegram clients currently .. automodule:: aiogram.api.types.inline_query_result :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_article.rst b/docs2/api/types/inline_query_result_article.rst similarity index 70% rename from docs2/source/api/types/inline_query_result_article.rst rename to docs2/api/types/inline_query_result_article.rst index eae120c6..52f68420 100644 --- a/docs2/source/api/types/inline_query_result_article.rst +++ b/docs2/api/types/inline_query_result_article.rst @@ -6,3 +6,6 @@ Represents a link to an article or web page. .. automodule:: aiogram.api.types.inline_query_result_article :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_audio.rst b/docs2/api/types/inline_query_result_audio.rst similarity index 84% rename from docs2/source/api/types/inline_query_result_audio.rst rename to docs2/api/types/inline_query_result_audio.rst index cf99a00e..84f91fd8 100644 --- a/docs2/source/api/types/inline_query_result_audio.rst +++ b/docs2/api/types/inline_query_result_audio.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old .. automodule:: aiogram.api.types.inline_query_result_audio :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_cached_audio.rst b/docs2/api/types/inline_query_result_cached_audio.rst similarity index 86% rename from docs2/source/api/types/inline_query_result_cached_audio.rst rename to docs2/api/types/inline_query_result_cached_audio.rst index e3faf146..961b4465 100644 --- a/docs2/source/api/types/inline_query_result_cached_audio.rst +++ b/docs2/api/types/inline_query_result_cached_audio.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old .. automodule:: aiogram.api.types.inline_query_result_cached_audio :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_cached_document.rst b/docs2/api/types/inline_query_result_cached_document.rst similarity index 86% rename from docs2/source/api/types/inline_query_result_cached_document.rst rename to docs2/api/types/inline_query_result_cached_document.rst index 89420202..3c0a20d7 100644 --- a/docs2/source/api/types/inline_query_result_cached_document.rst +++ b/docs2/api/types/inline_query_result_cached_document.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old .. automodule:: aiogram.api.types.inline_query_result_cached_document :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_cached_gif.rst b/docs2/api/types/inline_query_result_cached_gif.rst similarity index 84% rename from docs2/source/api/types/inline_query_result_cached_gif.rst rename to docs2/api/types/inline_query_result_cached_gif.rst index 7c593220..22979feb 100644 --- a/docs2/source/api/types/inline_query_result_cached_gif.rst +++ b/docs2/api/types/inline_query_result_cached_gif.rst @@ -6,3 +6,6 @@ Represents a link to an animated GIF file stored on the Telegram servers. By def .. automodule:: aiogram.api.types.inline_query_result_cached_gif :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_cached_mpeg4_gif.rst b/docs2/api/types/inline_query_result_cached_mpeg4_gif.rst similarity index 85% rename from docs2/source/api/types/inline_query_result_cached_mpeg4_gif.rst rename to docs2/api/types/inline_query_result_cached_mpeg4_gif.rst index 5cb2523a..779927c1 100644 --- a/docs2/source/api/types/inline_query_result_cached_mpeg4_gif.rst +++ b/docs2/api/types/inline_query_result_cached_mpeg4_gif.rst @@ -6,3 +6,6 @@ Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) st .. automodule:: aiogram.api.types.inline_query_result_cached_mpeg4_gif :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_cached_photo.rst b/docs2/api/types/inline_query_result_cached_photo.rst similarity index 83% rename from docs2/source/api/types/inline_query_result_cached_photo.rst rename to docs2/api/types/inline_query_result_cached_photo.rst index 79c558f8..57cb7602 100644 --- a/docs2/source/api/types/inline_query_result_cached_photo.rst +++ b/docs2/api/types/inline_query_result_cached_photo.rst @@ -6,3 +6,6 @@ Represents a link to a photo stored on the Telegram servers. By default, this ph .. automodule:: aiogram.api.types.inline_query_result_cached_photo :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_cached_sticker.rst b/docs2/api/types/inline_query_result_cached_sticker.rst similarity index 87% rename from docs2/source/api/types/inline_query_result_cached_sticker.rst rename to docs2/api/types/inline_query_result_cached_sticker.rst index 0bff87a6..3ce563a5 100644 --- a/docs2/source/api/types/inline_query_result_cached_sticker.rst +++ b/docs2/api/types/inline_query_result_cached_sticker.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016 for .. automodule:: aiogram.api.types.inline_query_result_cached_sticker :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_cached_video.rst b/docs2/api/types/inline_query_result_cached_video.rst similarity index 83% rename from docs2/source/api/types/inline_query_result_cached_video.rst rename to docs2/api/types/inline_query_result_cached_video.rst index b608887d..34ee707f 100644 --- a/docs2/source/api/types/inline_query_result_cached_video.rst +++ b/docs2/api/types/inline_query_result_cached_video.rst @@ -6,3 +6,6 @@ Represents a link to a video file stored on the Telegram servers. By default, th .. automodule:: aiogram.api.types.inline_query_result_cached_video :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_cached_voice.rst b/docs2/api/types/inline_query_result_cached_voice.rst similarity index 86% rename from docs2/source/api/types/inline_query_result_cached_voice.rst rename to docs2/api/types/inline_query_result_cached_voice.rst index 438bc1e7..5d23420b 100644 --- a/docs2/source/api/types/inline_query_result_cached_voice.rst +++ b/docs2/api/types/inline_query_result_cached_voice.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old .. automodule:: aiogram.api.types.inline_query_result_cached_voice :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_contact.rst b/docs2/api/types/inline_query_result_contact.rst similarity index 85% rename from docs2/source/api/types/inline_query_result_contact.rst rename to docs2/api/types/inline_query_result_contact.rst index ecb2d55a..bb914b78 100644 --- a/docs2/source/api/types/inline_query_result_contact.rst +++ b/docs2/api/types/inline_query_result_contact.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old .. automodule:: aiogram.api.types.inline_query_result_contact :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_document.rst b/docs2/api/types/inline_query_result_document.rst similarity index 86% rename from docs2/source/api/types/inline_query_result_document.rst rename to docs2/api/types/inline_query_result_document.rst index 6800b525..95dfd5e4 100644 --- a/docs2/source/api/types/inline_query_result_document.rst +++ b/docs2/api/types/inline_query_result_document.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old .. automodule:: aiogram.api.types.inline_query_result_document :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_game.rst b/docs2/api/types/inline_query_result_game.rst similarity index 79% rename from docs2/source/api/types/inline_query_result_game.rst rename to docs2/api/types/inline_query_result_game.rst index 9fb4527b..dc0aeefb 100644 --- a/docs2/source/api/types/inline_query_result_game.rst +++ b/docs2/api/types/inline_query_result_game.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after October 1, 2016. O .. automodule:: aiogram.api.types.inline_query_result_game :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_gif.rst b/docs2/api/types/inline_query_result_gif.rst similarity index 82% rename from docs2/source/api/types/inline_query_result_gif.rst rename to docs2/api/types/inline_query_result_gif.rst index a087a4fe..1b77b049 100644 --- a/docs2/source/api/types/inline_query_result_gif.rst +++ b/docs2/api/types/inline_query_result_gif.rst @@ -6,3 +6,6 @@ Represents a link to an animated GIF file. By default, this animated GIF file wi .. automodule:: aiogram.api.types.inline_query_result_gif :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_location.rst b/docs2/api/types/inline_query_result_location.rst similarity index 84% rename from docs2/source/api/types/inline_query_result_location.rst rename to docs2/api/types/inline_query_result_location.rst index 6f6def63..5f2398eb 100644 --- a/docs2/source/api/types/inline_query_result_location.rst +++ b/docs2/api/types/inline_query_result_location.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old .. automodule:: aiogram.api.types.inline_query_result_location :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_mpeg4_gif.rst b/docs2/api/types/inline_query_result_mpeg4_gif.rst similarity index 84% rename from docs2/source/api/types/inline_query_result_mpeg4_gif.rst rename to docs2/api/types/inline_query_result_mpeg4_gif.rst index 6763df77..8f86c6e5 100644 --- a/docs2/source/api/types/inline_query_result_mpeg4_gif.rst +++ b/docs2/api/types/inline_query_result_mpeg4_gif.rst @@ -6,3 +6,6 @@ Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). B .. automodule:: aiogram.api.types.inline_query_result_mpeg4_gif :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_photo.rst b/docs2/api/types/inline_query_result_photo.rst similarity index 81% rename from docs2/source/api/types/inline_query_result_photo.rst rename to docs2/api/types/inline_query_result_photo.rst index 0f5cc435..2bcced4b 100644 --- a/docs2/source/api/types/inline_query_result_photo.rst +++ b/docs2/api/types/inline_query_result_photo.rst @@ -6,3 +6,6 @@ Represents a link to a photo. By default, this photo will be sent by the user wi .. automodule:: aiogram.api.types.inline_query_result_photo :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_venue.rst b/docs2/api/types/inline_query_result_venue.rst similarity index 84% rename from docs2/source/api/types/inline_query_result_venue.rst rename to docs2/api/types/inline_query_result_venue.rst index dfc20d72..ca056b56 100644 --- a/docs2/source/api/types/inline_query_result_venue.rst +++ b/docs2/api/types/inline_query_result_venue.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old .. automodule:: aiogram.api.types.inline_query_result_venue :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_video.rst b/docs2/api/types/inline_query_result_video.rst similarity index 87% rename from docs2/source/api/types/inline_query_result_video.rst rename to docs2/api/types/inline_query_result_video.rst index 4dad781c..9e3dc1f8 100644 --- a/docs2/source/api/types/inline_query_result_video.rst +++ b/docs2/api/types/inline_query_result_video.rst @@ -8,3 +8,6 @@ If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), .. automodule:: aiogram.api.types.inline_query_result_video :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/inline_query_result_voice.rst b/docs2/api/types/inline_query_result_voice.rst similarity index 86% rename from docs2/source/api/types/inline_query_result_voice.rst rename to docs2/api/types/inline_query_result_voice.rst index 8c86958e..71c6d9d2 100644 --- a/docs2/source/api/types/inline_query_result_voice.rst +++ b/docs2/api/types/inline_query_result_voice.rst @@ -8,3 +8,6 @@ Note: This will only work in Telegram versions released after 9 April, 2016. Old .. automodule:: aiogram.api.types.inline_query_result_voice :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_contact_message_content.rst b/docs2/api/types/input_contact_message_content.rst similarity index 75% rename from docs2/source/api/types/input_contact_message_content.rst rename to docs2/api/types/input_contact_message_content.rst index 986fda0d..0af0edc4 100644 --- a/docs2/source/api/types/input_contact_message_content.rst +++ b/docs2/api/types/input_contact_message_content.rst @@ -6,3 +6,6 @@ Represents the content of a contact message to be sent as the result of an inlin .. automodule:: aiogram.api.types.input_contact_message_content :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_file.rst b/docs2/api/types/input_file.rst similarity index 75% rename from docs2/source/api/types/input_file.rst rename to docs2/api/types/input_file.rst index 1304bf28..10a17f5d 100644 --- a/docs2/source/api/types/input_file.rst +++ b/docs2/api/types/input_file.rst @@ -6,3 +6,6 @@ This object represents the contents of a file to be uploaded. Must be posted usi .. automodule:: aiogram.api.types.input_file :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_location_message_content.rst b/docs2/api/types/input_location_message_content.rst similarity index 75% rename from docs2/source/api/types/input_location_message_content.rst rename to docs2/api/types/input_location_message_content.rst index 1a18d4d6..b71b5e96 100644 --- a/docs2/source/api/types/input_location_message_content.rst +++ b/docs2/api/types/input_location_message_content.rst @@ -6,3 +6,6 @@ Represents the content of a location message to be sent as the result of an inli .. automodule:: aiogram.api.types.input_location_message_content :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_media.rst b/docs2/api/types/input_media.rst similarity index 77% rename from docs2/source/api/types/input_media.rst rename to docs2/api/types/input_media.rst index 8d4fd958..f7ccc7c8 100644 --- a/docs2/source/api/types/input_media.rst +++ b/docs2/api/types/input_media.rst @@ -16,3 +16,6 @@ This object represents the content of a media message to be sent. It should be o .. automodule:: aiogram.api.types.input_media :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_media_animation.rst b/docs2/api/types/input_media_animation.rst similarity index 72% rename from docs2/source/api/types/input_media_animation.rst rename to docs2/api/types/input_media_animation.rst index 02064f4e..af3ad3c6 100644 --- a/docs2/source/api/types/input_media_animation.rst +++ b/docs2/api/types/input_media_animation.rst @@ -6,3 +6,6 @@ Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be .. automodule:: aiogram.api.types.input_media_animation :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_media_audio.rst b/docs2/api/types/input_media_audio.rst similarity index 67% rename from docs2/source/api/types/input_media_audio.rst rename to docs2/api/types/input_media_audio.rst index a7fa516b..24320cf0 100644 --- a/docs2/source/api/types/input_media_audio.rst +++ b/docs2/api/types/input_media_audio.rst @@ -6,3 +6,6 @@ Represents an audio file to be treated as music to be sent. .. automodule:: aiogram.api.types.input_media_audio :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_media_document.rst b/docs2/api/types/input_media_document.rst similarity index 66% rename from docs2/source/api/types/input_media_document.rst rename to docs2/api/types/input_media_document.rst index f50dd71e..477c2481 100644 --- a/docs2/source/api/types/input_media_document.rst +++ b/docs2/api/types/input_media_document.rst @@ -6,3 +6,6 @@ Represents a general file to be sent. .. automodule:: aiogram.api.types.input_media_document :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_media_photo.rst b/docs2/api/types/input_media_photo.rst similarity index 63% rename from docs2/source/api/types/input_media_photo.rst rename to docs2/api/types/input_media_photo.rst index 937e0524..a7d8dd94 100644 --- a/docs2/source/api/types/input_media_photo.rst +++ b/docs2/api/types/input_media_photo.rst @@ -6,3 +6,6 @@ Represents a photo to be sent. .. automodule:: aiogram.api.types.input_media_photo :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_media_video.rst b/docs2/api/types/input_media_video.rst similarity index 63% rename from docs2/source/api/types/input_media_video.rst rename to docs2/api/types/input_media_video.rst index 9f3d104d..d2fc17c6 100644 --- a/docs2/source/api/types/input_media_video.rst +++ b/docs2/api/types/input_media_video.rst @@ -6,3 +6,6 @@ Represents a video to be sent. .. automodule:: aiogram.api.types.input_media_video :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_message_content.rst b/docs2/api/types/input_message_content.rst similarity index 82% rename from docs2/source/api/types/input_message_content.rst rename to docs2/api/types/input_message_content.rst index 0f902053..1cfc6552 100644 --- a/docs2/source/api/types/input_message_content.rst +++ b/docs2/api/types/input_message_content.rst @@ -14,3 +14,6 @@ This object represents the content of a message to be sent as a result of an inl .. automodule:: aiogram.api.types.input_message_content :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_text_message_content.rst b/docs2/api/types/input_text_message_content.rst similarity index 73% rename from docs2/source/api/types/input_text_message_content.rst rename to docs2/api/types/input_text_message_content.rst index 48b9b608..da9dd784 100644 --- a/docs2/source/api/types/input_text_message_content.rst +++ b/docs2/api/types/input_text_message_content.rst @@ -6,3 +6,6 @@ Represents the content of a text message to be sent as the result of an inline q .. automodule:: aiogram.api.types.input_text_message_content :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/input_venue_message_content.rst b/docs2/api/types/input_venue_message_content.rst similarity index 74% rename from docs2/source/api/types/input_venue_message_content.rst rename to docs2/api/types/input_venue_message_content.rst index 679f10eb..d7458c1b 100644 --- a/docs2/source/api/types/input_venue_message_content.rst +++ b/docs2/api/types/input_venue_message_content.rst @@ -6,3 +6,6 @@ Represents the content of a venue message to be sent as the result of an inline .. automodule:: aiogram.api.types.input_venue_message_content :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/invoice.rst b/docs2/api/types/invoice.rst similarity index 62% rename from docs2/source/api/types/invoice.rst rename to docs2/api/types/invoice.rst index 33f49597..f427e2e1 100644 --- a/docs2/source/api/types/invoice.rst +++ b/docs2/api/types/invoice.rst @@ -6,3 +6,6 @@ This object contains basic information about an invoice. .. automodule:: aiogram.api.types.invoice :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/keyboard_button.rst b/docs2/api/types/keyboard_button.rst similarity index 88% rename from docs2/source/api/types/keyboard_button.rst rename to docs2/api/types/keyboard_button.rst index 9135d3cb..741b3da8 100644 --- a/docs2/source/api/types/keyboard_button.rst +++ b/docs2/api/types/keyboard_button.rst @@ -10,3 +10,6 @@ Note: request_poll option will only work in Telegram versions released after 23 .. automodule:: aiogram.api.types.keyboard_button :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/keyboard_button_poll_type.rst b/docs2/api/types/keyboard_button_poll_type.rst similarity index 76% rename from docs2/source/api/types/keyboard_button_poll_type.rst rename to docs2/api/types/keyboard_button_poll_type.rst index 6ba3a378..eae38e30 100644 --- a/docs2/source/api/types/keyboard_button_poll_type.rst +++ b/docs2/api/types/keyboard_button_poll_type.rst @@ -6,3 +6,6 @@ This object represents type of a poll, which is allowed to be created and sent w .. automodule:: aiogram.api.types.keyboard_button_poll_type :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/labeled_price.rst b/docs2/api/types/labeled_price.rst similarity index 67% rename from docs2/source/api/types/labeled_price.rst rename to docs2/api/types/labeled_price.rst index c54459c6..557359c0 100644 --- a/docs2/source/api/types/labeled_price.rst +++ b/docs2/api/types/labeled_price.rst @@ -6,3 +6,6 @@ This object represents a portion of the price for goods or services. .. automodule:: aiogram.api.types.labeled_price :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/location.rst b/docs2/api/types/location.rst similarity index 60% rename from docs2/source/api/types/location.rst rename to docs2/api/types/location.rst index 2e7bee9a..aed07d25 100644 --- a/docs2/source/api/types/location.rst +++ b/docs2/api/types/location.rst @@ -6,3 +6,6 @@ This object represents a point on the map. .. automodule:: aiogram.api.types.location :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/login_url.rst b/docs2/api/types/login_url.rst similarity index 84% rename from docs2/source/api/types/login_url.rst rename to docs2/api/types/login_url.rst index fba92503..56c9229f 100644 --- a/docs2/source/api/types/login_url.rst +++ b/docs2/api/types/login_url.rst @@ -10,3 +10,6 @@ Sample bot: @discussbot .. automodule:: aiogram.api.types.login_url :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/mask_position.rst b/docs2/api/types/mask_position.rst similarity index 69% rename from docs2/source/api/types/mask_position.rst rename to docs2/api/types/mask_position.rst index f0101572..11d7e71b 100644 --- a/docs2/source/api/types/mask_position.rst +++ b/docs2/api/types/mask_position.rst @@ -6,3 +6,6 @@ This object describes the position on faces where a mask should be placed by def .. automodule:: aiogram.api.types.mask_position :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/message.rst b/docs2/api/types/message.rst similarity index 58% rename from docs2/source/api/types/message.rst rename to docs2/api/types/message.rst index 4603c9f2..d2dfc7b6 100644 --- a/docs2/source/api/types/message.rst +++ b/docs2/api/types/message.rst @@ -6,3 +6,6 @@ This object represents a message. .. automodule:: aiogram.api.types.message :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/message_entity.rst b/docs2/api/types/message_entity.rst similarity index 71% rename from docs2/source/api/types/message_entity.rst rename to docs2/api/types/message_entity.rst index ba3a35a2..87dfc66b 100644 --- a/docs2/source/api/types/message_entity.rst +++ b/docs2/api/types/message_entity.rst @@ -6,3 +6,6 @@ This object represents one special entity in a text message. For example, hashta .. automodule:: aiogram.api.types.message_entity :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/order_info.rst b/docs2/api/types/order_info.rst similarity index 63% rename from docs2/source/api/types/order_info.rst rename to docs2/api/types/order_info.rst index 080e56fb..cb0a66cd 100644 --- a/docs2/source/api/types/order_info.rst +++ b/docs2/api/types/order_info.rst @@ -6,3 +6,6 @@ This object represents information about an order. .. automodule:: aiogram.api.types.order_info :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_data.rst b/docs2/api/types/passport_data.rst similarity index 69% rename from docs2/source/api/types/passport_data.rst rename to docs2/api/types/passport_data.rst index 36a86c2b..e618c39f 100644 --- a/docs2/source/api/types/passport_data.rst +++ b/docs2/api/types/passport_data.rst @@ -6,3 +6,6 @@ Contains information about Telegram Passport data shared with the bot by the use .. automodule:: aiogram.api.types.passport_data :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_element_error.rst b/docs2/api/types/passport_element_error.rst similarity index 87% rename from docs2/source/api/types/passport_element_error.rst rename to docs2/api/types/passport_element_error.rst index 9713d2b7..174aa734 100644 --- a/docs2/source/api/types/passport_element_error.rst +++ b/docs2/api/types/passport_element_error.rst @@ -24,3 +24,6 @@ This object represents an error in the Telegram Passport element which was submi .. automodule:: aiogram.api.types.passport_element_error :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_element_error_data_field.rst b/docs2/api/types/passport_element_error_data_field.rst similarity index 79% rename from docs2/source/api/types/passport_element_error_data_field.rst rename to docs2/api/types/passport_element_error_data_field.rst index ddcbba8e..114b0982 100644 --- a/docs2/source/api/types/passport_element_error_data_field.rst +++ b/docs2/api/types/passport_element_error_data_field.rst @@ -6,3 +6,6 @@ Represents an issue in one of the data fields that was provided by the user. The .. automodule:: aiogram.api.types.passport_element_error_data_field :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_element_error_file.rst b/docs2/api/types/passport_element_error_file.rst similarity index 76% rename from docs2/source/api/types/passport_element_error_file.rst rename to docs2/api/types/passport_element_error_file.rst index ee26e42a..79a7c15e 100644 --- a/docs2/source/api/types/passport_element_error_file.rst +++ b/docs2/api/types/passport_element_error_file.rst @@ -6,3 +6,6 @@ Represents an issue with a document scan. The error is considered resolved when .. automodule:: aiogram.api.types.passport_element_error_file :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_element_error_files.rst b/docs2/api/types/passport_element_error_files.rst similarity index 77% rename from docs2/source/api/types/passport_element_error_files.rst rename to docs2/api/types/passport_element_error_files.rst index 107a5725..631c972b 100644 --- a/docs2/source/api/types/passport_element_error_files.rst +++ b/docs2/api/types/passport_element_error_files.rst @@ -6,3 +6,6 @@ Represents an issue with a list of scans. The error is considered resolved when .. automodule:: aiogram.api.types.passport_element_error_files :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_element_error_front_side.rst b/docs2/api/types/passport_element_error_front_side.rst similarity index 79% rename from docs2/source/api/types/passport_element_error_front_side.rst rename to docs2/api/types/passport_element_error_front_side.rst index 8920fb40..9437891a 100644 --- a/docs2/source/api/types/passport_element_error_front_side.rst +++ b/docs2/api/types/passport_element_error_front_side.rst @@ -6,3 +6,6 @@ Represents an issue with the front side of a document. The error is considered r .. automodule:: aiogram.api.types.passport_element_error_front_side :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_element_error_reverse_side.rst b/docs2/api/types/passport_element_error_reverse_side.rst similarity index 79% rename from docs2/source/api/types/passport_element_error_reverse_side.rst rename to docs2/api/types/passport_element_error_reverse_side.rst index 298926e0..1cc1a4b3 100644 --- a/docs2/source/api/types/passport_element_error_reverse_side.rst +++ b/docs2/api/types/passport_element_error_reverse_side.rst @@ -6,3 +6,6 @@ Represents an issue with the reverse side of a document. The error is considered .. automodule:: aiogram.api.types.passport_element_error_reverse_side :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_element_error_selfie.rst b/docs2/api/types/passport_element_error_selfie.rst similarity index 77% rename from docs2/source/api/types/passport_element_error_selfie.rst rename to docs2/api/types/passport_element_error_selfie.rst index 1817a1bf..4ebeed35 100644 --- a/docs2/source/api/types/passport_element_error_selfie.rst +++ b/docs2/api/types/passport_element_error_selfie.rst @@ -6,3 +6,6 @@ Represents an issue with the selfie with a document. The error is considered res .. automodule:: aiogram.api.types.passport_element_error_selfie :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_element_error_translation_file.rst b/docs2/api/types/passport_element_error_translation_file.rst similarity index 80% rename from docs2/source/api/types/passport_element_error_translation_file.rst rename to docs2/api/types/passport_element_error_translation_file.rst index 7ffed848..41d50c21 100644 --- a/docs2/source/api/types/passport_element_error_translation_file.rst +++ b/docs2/api/types/passport_element_error_translation_file.rst @@ -6,3 +6,6 @@ Represents an issue with one of the files that constitute the translation of a d .. automodule:: aiogram.api.types.passport_element_error_translation_file :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_element_error_translation_files.rst b/docs2/api/types/passport_element_error_translation_files.rst similarity index 80% rename from docs2/source/api/types/passport_element_error_translation_files.rst rename to docs2/api/types/passport_element_error_translation_files.rst index 0ce363e1..f82a2663 100644 --- a/docs2/source/api/types/passport_element_error_translation_files.rst +++ b/docs2/api/types/passport_element_error_translation_files.rst @@ -6,3 +6,6 @@ Represents an issue with the translated version of a document. The error is cons .. automodule:: aiogram.api.types.passport_element_error_translation_files :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_element_error_unspecified.rst b/docs2/api/types/passport_element_error_unspecified.rst similarity index 77% rename from docs2/source/api/types/passport_element_error_unspecified.rst rename to docs2/api/types/passport_element_error_unspecified.rst index 245acf4a..3556729a 100644 --- a/docs2/source/api/types/passport_element_error_unspecified.rst +++ b/docs2/api/types/passport_element_error_unspecified.rst @@ -6,3 +6,6 @@ Represents an issue in an unspecified place. The error is considered resolved wh .. automodule:: aiogram.api.types.passport_element_error_unspecified :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/passport_file.rst b/docs2/api/types/passport_file.rst similarity index 75% rename from docs2/source/api/types/passport_file.rst rename to docs2/api/types/passport_file.rst index 4b7c1446..358e12a7 100644 --- a/docs2/source/api/types/passport_file.rst +++ b/docs2/api/types/passport_file.rst @@ -6,3 +6,6 @@ This object represents a file uploaded to Telegram Passport. Currently all Teleg .. automodule:: aiogram.api.types.passport_file :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/photo_size.rst b/docs2/api/types/photo_size.rst similarity index 66% rename from docs2/source/api/types/photo_size.rst rename to docs2/api/types/photo_size.rst index 3ede4355..6503bab3 100644 --- a/docs2/source/api/types/photo_size.rst +++ b/docs2/api/types/photo_size.rst @@ -6,3 +6,6 @@ This object represents one size of a photo or a file / sticker thumbnail. .. automodule:: aiogram.api.types.photo_size :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/poll.rst b/docs2/api/types/poll.rst similarity index 58% rename from docs2/source/api/types/poll.rst rename to docs2/api/types/poll.rst index ed8df745..f5cb8f73 100644 --- a/docs2/source/api/types/poll.rst +++ b/docs2/api/types/poll.rst @@ -6,3 +6,6 @@ This object contains information about a poll. .. automodule:: aiogram.api.types.poll :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/poll_answer.rst b/docs2/api/types/poll_answer.rst similarity index 66% rename from docs2/source/api/types/poll_answer.rst rename to docs2/api/types/poll_answer.rst index ecd84970..ddd56d32 100644 --- a/docs2/source/api/types/poll_answer.rst +++ b/docs2/api/types/poll_answer.rst @@ -6,3 +6,6 @@ This object represents an answer of a user in a non-anonymous poll. .. automodule:: aiogram.api.types.poll_answer :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/poll_option.rst b/docs2/api/types/poll_option.rst similarity index 66% rename from docs2/source/api/types/poll_option.rst rename to docs2/api/types/poll_option.rst index 33e93b02..c5159c94 100644 --- a/docs2/source/api/types/poll_option.rst +++ b/docs2/api/types/poll_option.rst @@ -6,3 +6,6 @@ This object contains information about one answer option in a poll. .. automodule:: aiogram.api.types.poll_option :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/pre_checkout_query.rst b/docs2/api/types/pre_checkout_query.rst similarity index 69% rename from docs2/source/api/types/pre_checkout_query.rst rename to docs2/api/types/pre_checkout_query.rst index a2fba195..757a951c 100644 --- a/docs2/source/api/types/pre_checkout_query.rst +++ b/docs2/api/types/pre_checkout_query.rst @@ -6,3 +6,6 @@ This object contains information about an incoming pre-checkout query. .. automodule:: aiogram.api.types.pre_checkout_query :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/reply_keyboard_markup.rst b/docs2/api/types/reply_keyboard_markup.rst similarity index 74% rename from docs2/source/api/types/reply_keyboard_markup.rst rename to docs2/api/types/reply_keyboard_markup.rst index aa038328..34c83b86 100644 --- a/docs2/source/api/types/reply_keyboard_markup.rst +++ b/docs2/api/types/reply_keyboard_markup.rst @@ -6,3 +6,6 @@ This object represents a custom keyboard with reply options (see Introduction to .. automodule:: aiogram.api.types.reply_keyboard_markup :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/reply_keyboard_remove.rst b/docs2/api/types/reply_keyboard_remove.rst similarity index 85% rename from docs2/source/api/types/reply_keyboard_remove.rst rename to docs2/api/types/reply_keyboard_remove.rst index 253bdbce..2dddb8d7 100644 --- a/docs2/source/api/types/reply_keyboard_remove.rst +++ b/docs2/api/types/reply_keyboard_remove.rst @@ -6,3 +6,6 @@ Upon receiving a message with this object, Telegram clients will remove the curr .. automodule:: aiogram.api.types.reply_keyboard_remove :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/response_parameters.rst b/docs2/api/types/response_parameters.rst similarity index 69% rename from docs2/source/api/types/response_parameters.rst rename to docs2/api/types/response_parameters.rst index fd4a2aba..93b13fb5 100644 --- a/docs2/source/api/types/response_parameters.rst +++ b/docs2/api/types/response_parameters.rst @@ -6,3 +6,6 @@ Contains information about why a request was unsuccessful. .. automodule:: aiogram.api.types.response_parameters :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/shipping_address.rst b/docs2/api/types/shipping_address.rst similarity index 65% rename from docs2/source/api/types/shipping_address.rst rename to docs2/api/types/shipping_address.rst index 4358ce06..8a4d4571 100644 --- a/docs2/source/api/types/shipping_address.rst +++ b/docs2/api/types/shipping_address.rst @@ -6,3 +6,6 @@ This object represents a shipping address. .. automodule:: aiogram.api.types.shipping_address :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/shipping_option.rst b/docs2/api/types/shipping_option.rst similarity index 65% rename from docs2/source/api/types/shipping_option.rst rename to docs2/api/types/shipping_option.rst index 4845b9ea..cba2de77 100644 --- a/docs2/source/api/types/shipping_option.rst +++ b/docs2/api/types/shipping_option.rst @@ -6,3 +6,6 @@ This object represents one shipping option. .. automodule:: aiogram.api.types.shipping_option :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/shipping_query.rst b/docs2/api/types/shipping_query.rst similarity index 67% rename from docs2/source/api/types/shipping_query.rst rename to docs2/api/types/shipping_query.rst index 0e043612..bc7a3514 100644 --- a/docs2/source/api/types/shipping_query.rst +++ b/docs2/api/types/shipping_query.rst @@ -6,3 +6,6 @@ This object contains information about an incoming shipping query. .. automodule:: aiogram.api.types.shipping_query :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/sticker.rst b/docs2/api/types/sticker.rst similarity index 58% rename from docs2/source/api/types/sticker.rst rename to docs2/api/types/sticker.rst index 58183b01..3b6b4e1d 100644 --- a/docs2/source/api/types/sticker.rst +++ b/docs2/api/types/sticker.rst @@ -6,3 +6,6 @@ This object represents a sticker. .. automodule:: aiogram.api.types.sticker :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/sticker_set.rst b/docs2/api/types/sticker_set.rst similarity index 61% rename from docs2/source/api/types/sticker_set.rst rename to docs2/api/types/sticker_set.rst index fa99ffa1..2f19ce47 100644 --- a/docs2/source/api/types/sticker_set.rst +++ b/docs2/api/types/sticker_set.rst @@ -6,3 +6,6 @@ This object represents a sticker set. .. automodule:: aiogram.api.types.sticker_set :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/successful_payment.rst b/docs2/api/types/successful_payment.rst similarity index 69% rename from docs2/source/api/types/successful_payment.rst rename to docs2/api/types/successful_payment.rst index 771d671f..240b3cea 100644 --- a/docs2/source/api/types/successful_payment.rst +++ b/docs2/api/types/successful_payment.rst @@ -6,3 +6,6 @@ This object contains basic information about a successful payment. .. automodule:: aiogram.api.types.successful_payment :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/update.rst b/docs2/api/types/update.rst similarity index 70% rename from docs2/source/api/types/update.rst rename to docs2/api/types/update.rst index 60a6a8f2..88beec50 100644 --- a/docs2/source/api/types/update.rst +++ b/docs2/api/types/update.rst @@ -8,3 +8,6 @@ At most one of the optional parameters can be present in any given update. .. automodule:: aiogram.api.types.update :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/user.rst b/docs2/api/types/user.rst similarity index 58% rename from docs2/source/api/types/user.rst rename to docs2/api/types/user.rst index f40dc099..7e47d251 100644 --- a/docs2/source/api/types/user.rst +++ b/docs2/api/types/user.rst @@ -6,3 +6,6 @@ This object represents a Telegram user or bot. .. automodule:: aiogram.api.types.user :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/user_profile_photos.rst b/docs2/api/types/user_profile_photos.rst similarity index 67% rename from docs2/source/api/types/user_profile_photos.rst rename to docs2/api/types/user_profile_photos.rst index 3488c79f..f1d4516e 100644 --- a/docs2/source/api/types/user_profile_photos.rst +++ b/docs2/api/types/user_profile_photos.rst @@ -6,3 +6,6 @@ This object represent a user's profile pictures. .. automodule:: aiogram.api.types.user_profile_photos :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/venue.rst b/docs2/api/types/venue.rst similarity index 56% rename from docs2/source/api/types/venue.rst rename to docs2/api/types/venue.rst index 37f278bc..31c99522 100644 --- a/docs2/source/api/types/venue.rst +++ b/docs2/api/types/venue.rst @@ -6,3 +6,6 @@ This object represents a venue. .. automodule:: aiogram.api.types.venue :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/video.rst b/docs2/api/types/video.rst similarity index 57% rename from docs2/source/api/types/video.rst rename to docs2/api/types/video.rst index 0444003f..bb0ed56a 100644 --- a/docs2/source/api/types/video.rst +++ b/docs2/api/types/video.rst @@ -6,3 +6,6 @@ This object represents a video file. .. automodule:: aiogram.api.types.video :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/video_note.rst b/docs2/api/types/video_note.rst similarity index 67% rename from docs2/source/api/types/video_note.rst rename to docs2/api/types/video_note.rst index 1b26867d..e8177d09 100644 --- a/docs2/source/api/types/video_note.rst +++ b/docs2/api/types/video_note.rst @@ -6,3 +6,6 @@ This object represents a video message (available in Telegram apps as of v.4.0). .. automodule:: aiogram.api.types.video_note :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/voice.rst b/docs2/api/types/voice.rst similarity index 57% rename from docs2/source/api/types/voice.rst rename to docs2/api/types/voice.rst index c6af7008..bf101e94 100644 --- a/docs2/source/api/types/voice.rst +++ b/docs2/api/types/voice.rst @@ -6,3 +6,6 @@ This object represents a voice note. .. automodule:: aiogram.api.types.voice :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/types/webhook_info.rst b/docs2/api/types/webhook_info.rst similarity index 65% rename from docs2/source/api/types/webhook_info.rst rename to docs2/api/types/webhook_info.rst index c46d5675..d7c1f788 100644 --- a/docs2/source/api/types/webhook_info.rst +++ b/docs2/api/types/webhook_info.rst @@ -6,3 +6,6 @@ Contains information about the current status of a webhook. .. automodule:: aiogram.api.types.webhook_info :members: + :member-order: bysource + :special-members: __init__ + :undoc-members: True \ No newline at end of file diff --git a/docs2/source/api/upload_file.rst b/docs2/api/upload_file.rst similarity index 100% rename from docs2/source/api/upload_file.rst rename to docs2/api/upload_file.rst diff --git a/docs2/source/conf.py b/docs2/conf.py similarity index 91% rename from docs2/source/conf.py rename to docs2/conf.py index 1f7a4af6..03e0cda7 100644 --- a/docs2/source/conf.py +++ b/docs2/conf.py @@ -55,9 +55,3 @@ texinfo_documents = [ "Miscellaneous", ), ] - -autodoc_default_options = { - 'member-order': 'bysource', - 'special-members': '__init__', - 'undoc-members': True, -} diff --git a/docs2/dispatcher/dispatcher.rst b/docs2/dispatcher/dispatcher.rst new file mode 100644 index 00000000..798d74da --- /dev/null +++ b/docs2/dispatcher/dispatcher.rst @@ -0,0 +1,72 @@ +########## +Dispathcer +########## + +Dispatcher is root :obj:`Router` and in code Dispatcher can be used directly for routing updates or attach another routers into dispatcher. + +Here is only listed base information about Dispatcher. All about writing handlers, filters and etc. you can found in next pages: + +- `Router `__ +- `Observer `__ + + +.. autoclass:: aiogram.dispatcher.dispatcher.Dispatcher + :members: __init__, feed_update, feed_raw_update, feed_webhook_update, start_polling, run_polling + + +Simple usage +============ + +Example: + +.. code-block:: python + + dp = Dispatcher() + + @dp.message() + async def message_handler(message: types.Message) -> None: + await SendMessage(chat_id=message.from_user.id, text=message.text) + + +Including routers + +Example: + + +.. code-block:: python + + dp = Dispatcher() + router1 = Router() + dp.include_router(router1) + +Handling updates +================ + +All updates can be propagated to the dispatcher by :obj:`Dispatcher.feed_update(bot=..., update=...)` method: + +.. code-block:: python + + bot = Bot(...) + dp = Dispathcher() + + ... + + result = await dp.feed_update(bot=bot, update=incoming_update) + +Polling +======= + +.. warning:: + + not yet docummented + +... + +Webhook +======= + +.. warning:: + + not yet docummented + +... diff --git a/docs2/dispatcher/index.rst b/docs2/dispatcher/index.rst new file mode 100644 index 00000000..36b27ec8 --- /dev/null +++ b/docs2/dispatcher/index.rst @@ -0,0 +1,22 @@ +=============== +Handling events +=============== + +*aiogram* imcludes Dispatcher mechanism. +Dispatcher is needed for handling incoming updates from Telegram. + +With dispatcher you can do: + +- Handle incoming updates; +- Filter incoming events before it will be processed by specific handler; +- Modify event and related data in middlewares; +- Separate bot functionality between different handlers, modules and packages + +Dispatcher is also separated into two entities - Router and Dispatcher. +Dispatcher is subclass of router and should be always is root router. + +.. toctree:: + + observer + router + dispatcher diff --git a/docs2/dispatcher/observer.rst b/docs2/dispatcher/observer.rst new file mode 100644 index 00000000..44cc10df --- /dev/null +++ b/docs2/dispatcher/observer.rst @@ -0,0 +1,26 @@ +######## +Observer +######## + +Observer is used for filtering and handling different events. That is part of internal API with some public methods and is recommended to don't use methods is not listed here. + +In `aiogram` framework is available two variants of observer: + +- `EventObserver <#eventobserver>`__ +- `TelegramEventObserver <#telegrameventobserver>`__ + + +EventObserver +============= + +.. autoclass:: aiogram.dispatcher.event.event.EventObserver + :members: register, trigger, __call__ + :member-order: bysource + + +TelegramEventObserver +===================== + +.. autoclass:: aiogram.dispatcher.event.telegram.TelegramEventObserver + :members: register, trigger, __call__, bind_filter, middleware, outer_middleware + :member-order: bysource diff --git a/docs2/dispatcher/router.rst b/docs2/dispatcher/router.rst new file mode 100644 index 00000000..3e1a1b69 --- /dev/null +++ b/docs2/dispatcher/router.rst @@ -0,0 +1,181 @@ +###### +Router +###### + +.. autoclass:: aiogram.dispatcher.router.Router + :members: __init__, include_router + :show-inheritance: + + +Event observers +=============== + +.. warning:: + + All handlers is always should be an asynchronous. + Name of handler function is not important. Event argument name is also is not important but is recommended to don't overlap the name with contextual data in due to function can not accept two arguments with the same name. + +Here is list of available observers and examples how to register handlers (In examples used only @decorator-style): + +For examples used decorator-style registering handlers but if you dont like @decorators just use :obj:`.register(...)` method instead. + +Update +------ + +.. code-block:: python + + @router.update() + async def message_handler(update: types.Update) -> Any: pass + +.. note:: + + By default Router is already have an update handler which route all event types to another observers. + + +Message +------- + +.. code-block:: python + + @router.message() + async def message_handler(message: types.Message) -> Any: pass + + +Edited message +-------------- + +.. code-block:: python + + @router.edited_message() + async def edited_message_handler(edited_message: types.Message) -> Any: pass + +Channel post +------------ + +.. code-block:: python + + @router.channel_post() + async def channel_post_handler(channel_post: types.Message) -> Any: pass + +Edited channel post +------------------- + +.. code-block:: python + + @router.edited_channel_post() + async def edited_channel_post_handler(edited_channel_post: types.Message) -> Any: pass + + +Inline query +------------ + +.. code-block:: python + + @router.inline_query() + async def inline_query_handler(inline_query: types.Message) -> Any: pass + +Chosen inline query +------------------- + +.. code-block:: python + + @router.chosen_inline_result() + async def chosen_inline_result_handler(chosen_inline_result: types.ChosenInlineResult) -> Any: pass + +Callback query +-------------- + +.. code-block:: python + + @router.callback_query() + async def callback_query_handler(callback_query: types.CallbackQuery) -> Any: pass + +Shipping query +-------------- + +.. code-block:: python + + @router.shipping_query() + async def shipping_query_handler(shipping_query: types.ShippingQuery) -> Any: pass + +Pre checkout query +------------------ + +.. code-block:: python + + @router.pre_checkout_query() + async def pre_checkout_query_handler(pre_checkout_query: types.PreCheckoutQuery) -> Any: pass + +Poll +---- + +.. code-block:: python + + @router.poll() + async def poll_handler(poll: types.Poll) -> Any: pass + +Poll answer +----------- + +.. code-block:: python + + @router.poll_answer() + async def poll_answer_handler(poll_answer: types.PollAnswer) -> Any: pass + +Errors +------ + +.. code-block:: python + + @router.errors() + async def error_handler(exception: Exception) -> Any: pass + +Is useful for handling errors from other handlers + + +Nested routers +============== + +.. warning:: + + Routers by the way can be nested to an another routers with some limitations: + + 1. Router **CAN NOT** include itself + 1. Routers **CAN NOT** be used for circular including (router 1 include router 2, router 2 include router 3, router 3 include router 1) + + +Example: + +.. code-block:: python + :caption: module_2.py + :name: module_2 + + router2 = Router() + + @router2.message() + ... + + +.. code-block:: python + :caption: module_12.py + :name: module_1 + + from module_2 import router2 + + + router1 = Router() + router1.include_router(router2) + + +How it works? +------------- + +For example dispatcher has 2 routers, last one router is also have one nested router: + +.. image:: ../_static/nested_routers_example.png + :alt: Nested routers example + +In this case update propagation flow will have form: + +.. image:: ../_static/update_propagation_flow.png + :alt: Nested routers example diff --git a/docs2/source/index.rst b/docs2/index.rst similarity index 97% rename from docs2/source/index.rst rename to docs2/index.rst index 2821c9b0..8775c17a 100644 --- a/docs2/source/index.rst +++ b/docs2/index.rst @@ -70,7 +70,7 @@ Features Simple usage ------------ -.. literalinclude:: ../../examples/echo_bot.py +.. literalinclude:: ../examples/echo_bot.py Contents ======== @@ -80,3 +80,4 @@ Contents install api/index + dispatcher/index diff --git a/docs2/source/install.rst b/docs2/install.rst similarity index 100% rename from docs2/source/install.rst rename to docs2/install.rst diff --git a/docs2/make.bat b/docs2/make.bat index 9534b018..922152e9 100644 --- a/docs2/make.bat +++ b/docs2/make.bat @@ -7,8 +7,8 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=source -set BUILDDIR=build +set SOURCEDIR=. +set BUILDDIR=_build if "%1" == "" goto help