diff --git a/.butcher/templates/enum/enum.rst.jinja2 b/.butcher/templates/enum/enum.rst.jinja2 new file mode 100644 index 00000000..da25faa0 --- /dev/null +++ b/.butcher/templates/enum/enum.rst.jinja2 @@ -0,0 +1,13 @@ +{{ object.name|header('#') }} +{{ object.name }} +{{ object.name|header('#') }} + + +.. automodule:: aiogram.enums.{{ object.name|pythonize_name }} + :members: + :member-order: bysource + :undoc-members: True + +{% if docs %} +{{ docs }} +{% endif %} diff --git a/.butcher/templates/method/method.rst.jinja2 b/.butcher/templates/method/method.rst.jinja2 new file mode 100755 index 00000000..3e3ab837 --- /dev/null +++ b/.butcher/templates/method/method.rst.jinja2 @@ -0,0 +1,54 @@ +{{ object.name|header('#') }} +{{ object.name }} +{{ object.name|header('#') }} + +Returns: :obj:`{{ object.returning.parsed_type|type }}` + +.. automodule:: aiogram.methods.{{ object.name|pythonize_name }} + :members: + :member-order: bysource + :undoc-members: True + + +Usage +===== + +As bot method +------------- + +.. code-block:: + + result: {{ object.returning.parsed_type|type }} = await bot.{{ object.name|pythonize_name }}(...) + + +Method as object +---------------- + +Imports: + +- :code:`from aiogram.methods.{{ object.name|pythonize_name }} import {{ object.name|pythonize_class_name }}` +- alias: :code:`from aiogram.methods import {{ object.name|pythonize_class_name }}` + +With specific bot +~~~~~~~~~~~~~~~~~ + +.. code-block:: python + + result: {{ object.returning.parsed_type|type }} = await bot({{ object.name|pythonize_class_name }}(...)) + +{% if can_be_used_in_webhook -%} +As reply into Webhook in handler +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: python + + return {{ object.name|pythonize_class_name }}(...) +{%- endif %} + +{% if aliased %} +As shortcut from received object +------------------- +{% for alias in aliased %} +- :meth:`aiogram.types.{{ alias.type|pythonize_name }}.{{ alias.type|pythonize_class_name }}.{{ alias.name }}` +{%- endfor %} +{% endif %} diff --git a/.butcher/templates/type/type.rst.jinja2 b/.butcher/templates/type/type.rst.jinja2 new file mode 100644 index 00000000..6b9907c3 --- /dev/null +++ b/.butcher/templates/type/type.rst.jinja2 @@ -0,0 +1,9 @@ +{{ object.name|header('#') }} +{{ object.name }} +{{ object.name|header('#') }} + + +.. automodule:: aiogram.types.{{ object.name|pythonize_name }} + :members: + :member-order: bysource + :undoc-members: True diff --git a/docs/api/enums/chat_type.rst b/docs/api/enums/chat_type.rst new file mode 100644 index 00000000..71f50f7b --- /dev/null +++ b/docs/api/enums/chat_type.rst @@ -0,0 +1,9 @@ +######## +ChatType +######## + + +.. automodule:: aiogram.enums.chat_type + :members: + :member-order: bysource + :undoc-members: True diff --git a/docs/api/enums/content_type.rst b/docs/api/enums/content_type.rst new file mode 100644 index 00000000..148694ba --- /dev/null +++ b/docs/api/enums/content_type.rst @@ -0,0 +1,9 @@ +########### +ContentType +########### + + +.. automodule:: aiogram.enums.content_type + :members: + :member-order: bysource + :undoc-members: True diff --git a/docs/api/enums/dice_emoji.rst b/docs/api/enums/dice_emoji.rst new file mode 100644 index 00000000..783c71bd --- /dev/null +++ b/docs/api/enums/dice_emoji.rst @@ -0,0 +1,9 @@ +######### +DiceEmoji +######### + + +.. automodule:: aiogram.enums.dice_emoji + :members: + :member-order: bysource + :undoc-members: True diff --git a/docs/api/enums/index.rst b/docs/api/enums/index.rst new file mode 100644 index 00000000..dcc35d86 --- /dev/null +++ b/docs/api/enums/index.rst @@ -0,0 +1,14 @@ +##### +Enums +##### + +Here is list of all available enums: + +.. toctree:: + :maxdepth: 1 + + chat_type + content_type + dice_emoji + topic_icon_color + update_type diff --git a/docs/api/enums/topic_icon_color.rst b/docs/api/enums/topic_icon_color.rst new file mode 100644 index 00000000..974a26cf --- /dev/null +++ b/docs/api/enums/topic_icon_color.rst @@ -0,0 +1,9 @@ +############## +TopicIconColor +############## + + +.. automodule:: aiogram.enums.topic_icon_color + :members: + :member-order: bysource + :undoc-members: True diff --git a/docs/api/enums/update_type.rst b/docs/api/enums/update_type.rst new file mode 100644 index 00000000..8c81bb58 --- /dev/null +++ b/docs/api/enums/update_type.rst @@ -0,0 +1,9 @@ +########## +UpdateType +########## + + +.. automodule:: aiogram.enums.update_type + :members: + :member-order: bysource + :undoc-members: True diff --git a/docs/api/index.rst b/docs/api/index.rst index e82565a8..d323ecf0 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -11,5 +11,6 @@ All methods and types is fully autogenerated from Telegram Bot API docs by parse session/index types/index methods/index + enums/index download_file upload_file