Update docs.

2025-12-08 17:13:56 +00:00 · 2019-08-17 00:08:04 +03:00 · 2019-08-17 00:08:04 +03:00 · 9a30285d3b
commit 9a30285d3b
parent 19fc1b8d80
13 changed files with 114 additions and 101 deletions
--- a/aiogram/utils/exceptions.py
+++ b/aiogram/utils/exceptions.py
@ -1,94 +1,92 @@
 """
-TelegramAPIError
-    ValidationError
-    Throttled
-    BadRequest
-        MessageError
-            MessageNotModified
-            MessageToForwardNotFound
-            MessageToDeleteNotFound
-            MessageIdentifierNotSpecified
-            MessageTextIsEmpty
-            MessageCantBeEdited
-            MessageCantBeDeleted
-            MessageToEditNotFound
-            MessageToReplyNotFound
-            ToMuchMessages
-        PollError
-            PollCantBeStopped
-            PollHasAlreadyClosed
-            PollsCantBeSentToPrivateChats
-            PollSizeError
-                PollMustHaveMoreOptions
-                PollCantHaveMoreOptions
-                PollsOptionsLengthTooLong
-                PollOptionsMustBeNonEmpty
-                PollQuestionMustBeNonEmpty
-            MessageWithPollNotFound (with MessageError)
-            MessageIsNotAPoll (with MessageError)
-        ObjectExpectedAsReplyMarkup
-        InlineKeyboardExpected
-        ChatNotFound
-        ChatDescriptionIsNotModified
-        InvalidQueryID
-        InvalidPeerID
-        InvalidHTTPUrlContent
-        ButtonURLInvalid
-        URLHostIsEmpty
-        StartParamInvalid
-        ButtonDataInvalid
-        WrongFileIdentifier
-        GroupDeactivated
-        BadWebhook
-            WebhookRequireHTTPS
-            BadWebhookPort
-            BadWebhookAddrInfo
-            BadWebhookNoAddressAssociatedWithHostname
-        NotFound
-            MethodNotKnown
-        PhotoAsInputFileRequired
-        InvalidStickersSet
-        NoStickerInRequest
-        ChatAdminRequired
-        NeedAdministratorRightsInTheChannel
-        MethodNotAvailableInPrivateChats
-        CantDemoteChatCreator
-        CantRestrictSelf
-        NotEnoughRightsToRestrict
-        PhotoDimensions
-        UnavailableMembers
-        TypeOfFileMismatch
-        WrongRemoteFileIdSpecified
-        PaymentProviderInvalid
-        CurrencyTotalAmountInvalid
-        CantParseUrl
-        UnsupportedUrlProtocol
-        CantParseEntities
-        ResultIdDuplicate
-    ConflictError
-        TerminatedByOtherGetUpdates
-        CantGetUpdates
-    Unauthorized
-        BotKicked
-        BotBlocked
-        UserDeactivated
-        CantInitiateConversation
-        CantTalkWithBots
-    NetworkError
-    RetryAfter
-    MigrateToChat
-    RestartingTelegram
+- TelegramAPIError
+    - ValidationError
+    - Throttled
+    - BadRequest
+        - MessageError
+            - MessageNotModified
+            - MessageToForwardNotFound
+            - MessageToDeleteNotFound
+            - MessageIdentifierNotSpecified
+            - MessageTextIsEmpty
+            - MessageCantBeEdited
+            - MessageCantBeDeleted
+            - MessageToEditNotFound
+            - MessageToReplyNotFound
+            - ToMuchMessages
+        - PollError
+            - PollCantBeStopped
+            - PollHasAlreadyClosed
+            - PollsCantBeSentToPrivateChats
+            - PollSizeError
+                - PollMustHaveMoreOptions
+                - PollCantHaveMoreOptions
+                - PollsOptionsLengthTooLong
+                - PollOptionsMustBeNonEmpty
+                - PollQuestionMustBeNonEmpty
+            - MessageWithPollNotFound (with MessageError)
+            - MessageIsNotAPoll (with MessageError)
+        - ObjectExpectedAsReplyMarkup
+        - InlineKeyboardExpected
+        - ChatNotFound
+        - ChatDescriptionIsNotModified
+        - InvalidQueryID
+        - InvalidPeerID
+        - InvalidHTTPUrlContent
+        - ButtonURLInvalid
+        - URLHostIsEmpty
+        - StartParamInvalid
+        - ButtonDataInvalid
+        - WrongFileIdentifier
+        - GroupDeactivated
+        - BadWebhook
+            - WebhookRequireHTTPS
+            - BadWebhookPort
+            - BadWebhookAddrInfo
+            - BadWebhookNoAddressAssociatedWithHostname
+        - NotFound
+            - MethodNotKnown
+        - PhotoAsInputFileRequired
+        - InvalidStickersSet
+        - NoStickerInRequest
+        - ChatAdminRequired
+        - NeedAdministratorRightsInTheChannel
+        - MethodNotAvailableInPrivateChats
+        - CantDemoteChatCreator
+        - CantRestrictSelf
+        - NotEnoughRightsToRestrict
+        - PhotoDimensions
+        - UnavailableMembers
+        - TypeOfFileMismatch
+        - WrongRemoteFileIdSpecified
+        - PaymentProviderInvalid
+        - CurrencyTotalAmountInvalid
+        - CantParseUrl
+        - UnsupportedUrlProtocol
+        - CantParseEntities
+        - ResultIdDuplicate
+    - ConflictError
+        - TerminatedByOtherGetUpdates
+        - CantGetUpdates
+    - Unauthorized
+        - BotKicked
+        - BotBlocked
+        - UserDeactivated
+        - CantInitiateConversation
+        - CantTalkWithBots
+    - NetworkError
+    - RetryAfter
+    - MigrateToChat
+    - RestartingTelegram

-
-TODO: aiogram.utils.exceptions.BadRequest: Bad request: can't parse entities: unsupported start tag "function" at byte offset 0
-TODO: aiogram.utils.exceptions.TelegramAPIError: Gateway Timeout
-
-AIOGramWarning
-    TimeoutWarning
+- AIOGramWarning
+    - TimeoutWarning
 """
 import time

 # TODO: Use exceptions detector from `aiograph`.
+# TODO: aiogram.utils.exceptions.BadRequest: Bad request: can't parse entities: unsupported start tag "function" at byte offset 0
+# TODO: aiogram.utils.exceptions.TelegramAPIError: Gateway Timeout

 _PREFIXES = ['error: ', '[error]: ', 'bad request: ', 'conflict: ', 'not found: ']

--- a/docs/source/utils/auth_widget.rst
+++ b/docs/source/utils/auth_widget.rst
@ -1,4 +1,6 @@
 ===========
 Auth Widget
 ===========
-Coming soon...
+
+.. automodule:: aiogram.utils.auth_widget
+    :members:
--- a/docs/source/utils/context.rst
+++ b/docs/source/utils/context.rst
@ -1,4 +0,0 @@
-=======
-Context
-=======
-Coming soon...
--- a/docs/source/utils/deprecated.rst
+++ b/docs/source/utils/deprecated.rst
@ -1,5 +1,6 @@
 ==========
 Deprecated
 ==========
+
 .. automodule:: aiogram.utils.deprecated
    :members:
--- a/docs/source/utils/emoji.rst
+++ b/docs/source/utils/emoji.rst
@ -1,4 +1,6 @@
 =====
 Emoji
 =====
-Coming soon...
+
+.. automodule:: aiogram.utils.emoji
+    :members:
--- a/docs/source/utils/exceptions.rst
+++ b/docs/source/utils/exceptions.rst
@ -1,4 +1,6 @@
 ==========
 Exceptions
 ==========
-Coming soon...
+
+.. automodule:: aiogram.utils.exceptions
+    :members:
--- a/docs/source/utils/executor.rst
+++ b/docs/source/utils/executor.rst
@ -1,4 +1,7 @@
 ========
 Executor
 ========
-Coming soon...
+
+.. automodule:: aiogram.utils.executor
+    :members:
+
--- a/docs/source/utils/helper.rst
+++ b/docs/source/utils/helper.rst
@ -1,4 +1,6 @@
 ======
 Helper
 ======
-Coming soon...
+
+.. automodule:: aiogram.utils.helper
+    :members:
--- a/docs/source/utils/index.rst
+++ b/docs/source/utils/index.rst
@ -3,14 +3,13 @@ Utils

 .. toctree::

+    auth_widget
    executor
    exceptions
-    context
    markdown
    helper
-    auth_widget
+    deprecated
    payload
    parts
    json
    emoji
-    deprecated
--- a/docs/source/utils/json.rst
+++ b/docs/source/utils/json.rst
@ -1,4 +1,6 @@
 ====
 JSON
 ====
-Coming soon...
+
+.. automodule:: aiogram.utils.json
+    :members:
--- a/docs/source/utils/markdown.rst
+++ b/docs/source/utils/markdown.rst
@ -1,4 +1,6 @@
 ========
 Markdown
 ========
-Coming soon...
+
+.. automodule:: aiogram.utils.markdown
+    :members:
--- a/docs/source/utils/parts.rst
+++ b/docs/source/utils/parts.rst
@ -1,4 +1,6 @@
 =====
 Parts
 =====
-Coming soon...
+
+.. automodule:: aiogram.utils.parts
+    :members:
--- a/docs/source/utils/payload.rst
+++ b/docs/source/utils/payload.rst
@ -1,4 +1,6 @@
 =======
 Payload
 =======
-Coming soon...
+
+.. automodule:: aiogram.utils.payload
+    :members: