Added enum docs

This commit is contained in:
Alex Root Junior 2022-11-20 21:56:07 +02:00
parent 8011985388
commit 58c3a68696
No known key found for this signature in database
GPG key ID: 074C1D455EBEA4AC
10 changed files with 136 additions and 0 deletions

View file

@ -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 %}

View file

@ -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 %}

View file

@ -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

View file

@ -0,0 +1,9 @@
########
ChatType
########
.. automodule:: aiogram.enums.chat_type
:members:
:member-order: bysource
:undoc-members: True

View file

@ -0,0 +1,9 @@
###########
ContentType
###########
.. automodule:: aiogram.enums.content_type
:members:
:member-order: bysource
:undoc-members: True

View file

@ -0,0 +1,9 @@
#########
DiceEmoji
#########
.. automodule:: aiogram.enums.dice_emoji
:members:
:member-order: bysource
:undoc-members: True

14
docs/api/enums/index.rst Normal file
View file

@ -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

View file

@ -0,0 +1,9 @@
##############
TopicIconColor
##############
.. automodule:: aiogram.enums.topic_icon_color
:members:
:member-order: bysource
:undoc-members: True

View file

@ -0,0 +1,9 @@
##########
UpdateType
##########
.. automodule:: aiogram.enums.update_type
:members:
:member-order: bysource
:undoc-members: True

View file

@ -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