diff --git a/.butcher/templates/enum/enum.rst.jinja2 b/.butcher/templates/enums/entity.rst.jinja2 similarity index 100% rename from .butcher/templates/enum/enum.rst.jinja2 rename to .butcher/templates/enums/entity.rst.jinja2 diff --git a/.butcher/templates/enums/index.rst.jinja2 b/.butcher/templates/enums/index.rst.jinja2 new file mode 100644 index 00000000..9ecd07f7 --- /dev/null +++ b/.butcher/templates/enums/index.rst.jinja2 @@ -0,0 +1,16 @@ +##### +Types +##### + +Here is list of all available enums: + +{% for title, group in groups.items() %} +{{ title }} +{{ title|header('=') }} + +.. toctree:: + :maxdepth: 1 +{% for name in group %} + {{ name|pythonize_name }} +{%- endfor %} +{% endfor %} diff --git a/.butcher/templates/method/method.rst.jinja2 b/.butcher/templates/methods/entity.rst.jinja2 similarity index 100% rename from .butcher/templates/method/method.rst.jinja2 rename to .butcher/templates/methods/entity.rst.jinja2 diff --git a/.butcher/templates/methods/index.rst.jinja2 b/.butcher/templates/methods/index.rst.jinja2 new file mode 100644 index 00000000..a8e04c97 --- /dev/null +++ b/.butcher/templates/methods/index.rst.jinja2 @@ -0,0 +1,16 @@ +####### +Methods +####### + +Here is list of all available API methods: + +{% for title, group in groups.items() %} +{{ title }} +{{ title|header('=') }} + +.. toctree:: + :maxdepth: 1 +{% for name in group %} + {{ name|pythonize_name }} +{%- endfor %} +{% endfor %} diff --git a/.butcher/templates/type/type.rst.jinja2 b/.butcher/templates/types/entity.rst.jinja2 similarity index 100% rename from .butcher/templates/type/type.rst.jinja2 rename to .butcher/templates/types/entity.rst.jinja2 diff --git a/.butcher/templates/types/index.rst.jinja2 b/.butcher/templates/types/index.rst.jinja2 new file mode 100644 index 00000000..c812ce24 --- /dev/null +++ b/.butcher/templates/types/index.rst.jinja2 @@ -0,0 +1,16 @@ +##### +Types +##### + +Here is list of all available API types: + +{% for title, group in groups.items() %} +{{ title }} +{{ title|header('=') }} + +.. toctree:: + :maxdepth: 1 +{% for name in group %} + {{ name|pythonize_name }} +{%- endfor %} +{% endfor %} diff --git a/docs/api/methods/index.rst b/docs/api/methods/index.rst index a47ea7f6..fed00c32 100644 --- a/docs/api/methods/index.rst +++ b/docs/api/methods/index.rst @@ -5,19 +5,6 @@ Methods Here is list of all available API methods: - -Getting updates -=============== - -.. toctree:: - :maxdepth: 1 - - get_updates - set_webhook - delete_webhook - get_webhook_info - - Available methods ================= @@ -25,112 +12,72 @@ Available methods :maxdepth: 1 get_me - log_out - close - send_message + set_chat_photo + unpin_all_chat_messages + close_forum_topic + set_chat_title + delete_chat_photo + set_chat_sticker_set forward_message - copy_message - send_photo - send_audio - send_document - send_video - send_animation - send_voice - send_video_note - send_media_group - send_location - edit_message_live_location - stop_message_live_location - send_venue - send_contact - send_poll - send_dice - send_chat_action + get_chat + approve_chat_join_request get_user_profile_photos - get_file - ban_chat_member - kick_chat_member - unban_chat_member - restrict_chat_member + create_forum_topic + create_chat_invite_link + delete_my_commands + stop_message_live_location + get_chat_member promote_chat_member set_chat_administrator_custom_title - ban_chat_sender_chat - unban_chat_sender_chat - set_chat_permissions - export_chat_invite_link - create_chat_invite_link - edit_chat_invite_link - revoke_chat_invite_link - approve_chat_join_request - decline_chat_join_request - set_chat_photo - delete_chat_photo - set_chat_title - set_chat_description - pin_chat_message - unpin_chat_message - unpin_all_chat_messages leave_chat - get_chat - get_chat_administrators - get_chat_member_count - get_chat_members_count - get_chat_member - set_chat_sticker_set - delete_chat_sticker_set - get_forum_topic_icon_stickers - create_forum_topic - edit_forum_topic - close_forum_topic - reopen_forum_topic - delete_forum_topic - unpin_all_forum_topic_messages - answer_callback_query + send_dice + send_contact set_my_commands - delete_my_commands - get_my_commands - set_chat_menu_button + send_voice + send_animation + send_venue + send_document + send_media_group get_chat_menu_button - set_my_default_administrator_rights + send_audio + send_photo + export_chat_invite_link + send_chat_action + ban_chat_sender_chat + unban_chat_member + delete_chat_sticker_set + decline_chat_join_request + delete_forum_topic get_my_default_administrator_rights - -Updating messages -================= - -.. toctree:: - :maxdepth: 1 - - edit_message_text - edit_message_caption - edit_message_media - edit_message_reply_markup - stop_poll - delete_message - -Stickers -======== - -.. toctree:: - :maxdepth: 1 - - send_sticker - get_sticker_set - get_custom_emoji_stickers - upload_sticker_file - create_new_sticker_set - add_sticker_to_set - set_sticker_position_in_set - delete_sticker_from_set - set_sticker_set_thumb - -Inline mode -=========== - -.. toctree:: - :maxdepth: 1 - - answer_inline_query - answer_web_app_query + unpin_chat_message + get_forum_topic_icon_stickers + reopen_forum_topic + copy_message + restrict_chat_member + send_location + set_chat_description + edit_chat_invite_link + send_video_note + get_file + get_my_commands + close + set_chat_permissions + pin_chat_message + set_my_default_administrator_rights + edit_forum_topic + send_message + set_chat_menu_button + revoke_chat_invite_link + edit_message_live_location + unpin_all_forum_topic_messages + send_poll + ban_chat_member + get_chat_member_count + log_out + unban_chat_sender_chat + answer_callback_query + get_chat_administrators + send_video Payments ======== @@ -138,10 +85,47 @@ Payments .. toctree:: :maxdepth: 1 - send_invoice + answer_pre_checkout_query create_invoice_link answer_shipping_query - answer_pre_checkout_query + send_invoice + +Stickers +======== + +.. toctree:: + :maxdepth: 1 + + get_custom_emoji_stickers + get_sticker_set + create_new_sticker_set + send_sticker + upload_sticker_file + set_sticker_set_thumb + add_sticker_to_set + set_sticker_position_in_set + delete_sticker_from_set + +Games +===== + +.. toctree:: + :maxdepth: 1 + + get_game_high_scores + set_game_score + send_game + +Getting updates +=============== + +.. toctree:: + :maxdepth: 1 + + get_webhook_info + set_webhook + get_updates + delete_webhook Telegram Passport ================= @@ -151,12 +135,24 @@ Telegram Passport set_passport_data_errors -Games -===== +Updating messages +================= .. toctree:: :maxdepth: 1 - send_game - set_game_score - get_game_high_scores + edit_message_caption + edit_message_media + delete_message + edit_message_text + edit_message_reply_markup + stop_poll + +Inline mode +=========== + +.. toctree:: + :maxdepth: 1 + + answer_web_app_query + answer_inline_query diff --git a/docs/api/types/index.rst b/docs/api/types/index.rst index 97a876e6..7df760a2 100644 --- a/docs/api/types/index.rst +++ b/docs/api/types/index.rst @@ -5,6 +5,147 @@ Types Here is list of all available API types: +Inline mode +=========== + +.. toctree:: + :maxdepth: 1 + + input_invoice_message_content + inline_query_result_document + input_message_content + inline_query_result_cached_document + inline_query_result_contact + inline_query_result_cached_gif + inline_query_result_location + input_venue_message_content + chosen_inline_result + inline_query_result + inline_query_result_cached_mpeg4_gif + inline_query_result_game + inline_query_result_cached_sticker + inline_query_result_gif + inline_query_result_cached_voice + inline_query_result_cached_video + input_location_message_content + input_text_message_content + inline_query_result_cached_audio + inline_query_result_video + inline_query_result_article + inline_query_result_audio + inline_query_result_cached_photo + inline_query + inline_query_result_venue + inline_query_result_photo + input_contact_message_content + inline_query_result_mpeg4_gif + inline_query_result_voice + sent_web_app_message + +Available types +=============== + +.. toctree:: + :maxdepth: 1 + + chat_administrator_rights + proximity_alert_triggered + bot_command_scope_all_private_chats + input_media_photo + message_entity + message + bot_command_scope_chat + forum_topic_reopened + reply_keyboard_remove + video + poll_option + login_url + location + chat_location + chat_member_administrator + menu_button_default + web_app_data + chat_member + user + file + poll_answer + chat_member_restricted + chat_member_updated + keyboard_button_poll_type + chat_permissions + poll + chat_member_banned + venue + video_chat_participants_invited + response_parameters + menu_button_web_app + force_reply + chat_member_left + bot_command_scope_default + input_media_audio + keyboard_button + video_chat_ended + inline_keyboard_button + callback_query + bot_command_scope_all_group_chats + user_profile_photos + chat_invite_link + input_media + chat_photo + chat_join_request + bot_command_scope_chat_administrators + forum_topic_created + bot_command_scope + bot_command + document + reply_keyboard_markup + chat_member_member + photo_size + bot_command_scope_chat_member + voice + input_file + input_media_animation + video_note + video_chat_started + message_id + audio + menu_button + input_media_document + dice + message_auto_delete_timer_changed + bot_command_scope_all_chat_administrators + web_app_info + contact + animation + input_media_video + forum_topic + forum_topic_closed + inline_keyboard_markup + video_chat_scheduled + chat_member_owner + chat + menu_button_commands + +Telegram Passport +================= + +.. toctree:: + :maxdepth: 1 + + passport_data + passport_element_error_reverse_side + passport_element_error_data_field + passport_element_error_selfie + passport_element_error + passport_element_error_unspecified + passport_element_error_file + passport_element_error_translation_files + encrypted_passport_element + passport_file + passport_element_error_front_side + passport_element_error_files + encrypted_credentials + passport_element_error_translation_file Getting updates =============== @@ -15,138 +156,15 @@ Getting updates update webhook_info -Available types -=============== - -.. toctree:: - :maxdepth: 1 - - user - chat - message - message_id - message_entity - photo_size - animation - audio - document - video - video_note - voice - contact - dice - poll_option - poll_answer - poll - location - venue - web_app_data - proximity_alert_triggered - message_auto_delete_timer_changed - forum_topic_created - forum_topic_closed - forum_topic_reopened - video_chat_scheduled - video_chat_started - video_chat_ended - video_chat_participants_invited - user_profile_photos - file - web_app_info - reply_keyboard_markup - keyboard_button - keyboard_button_poll_type - reply_keyboard_remove - inline_keyboard_markup - inline_keyboard_button - login_url - callback_query - force_reply - chat_photo - chat_invite_link - chat_administrator_rights - chat_member - chat_member_owner - chat_member_administrator - chat_member_member - chat_member_restricted - chat_member_left - chat_member_banned - chat_member_updated - chat_join_request - chat_permissions - chat_location - forum_topic - bot_command - bot_command_scope - bot_command_scope_default - bot_command_scope_all_private_chats - bot_command_scope_all_group_chats - bot_command_scope_all_chat_administrators - bot_command_scope_chat - bot_command_scope_chat_administrators - bot_command_scope_chat_member - menu_button - menu_button_commands - menu_button_web_app - menu_button_default - response_parameters - input_media - input_media_photo - input_media_video - input_media_animation - input_media_audio - input_media_document - input_file - - - Stickers ======== .. toctree:: :maxdepth: 1 - sticker sticker_set mask_position - -Inline mode -=========== - -.. toctree:: - :maxdepth: 1 - - inline_query - inline_query_result - inline_query_result_article - inline_query_result_photo - inline_query_result_gif - inline_query_result_mpeg4_gif - inline_query_result_video - inline_query_result_audio - inline_query_result_voice - inline_query_result_document - inline_query_result_location - inline_query_result_venue - inline_query_result_contact - inline_query_result_game - inline_query_result_cached_photo - inline_query_result_cached_gif - inline_query_result_cached_mpeg4_gif - inline_query_result_cached_sticker - inline_query_result_cached_document - inline_query_result_cached_video - inline_query_result_cached_voice - inline_query_result_cached_audio - input_message_content - input_text_message_content - input_location_message_content - input_venue_message_content - input_contact_message_content - input_invoice_message_content - chosen_inline_result - sent_web_app_message + sticker Payments ======== @@ -154,35 +172,14 @@ Payments .. toctree:: :maxdepth: 1 + pre_checkout_query + shipping_query labeled_price invoice - shipping_address - order_info shipping_option successful_payment - shipping_query - pre_checkout_query - -Telegram Passport -================= - -.. toctree:: - :maxdepth: 1 - - passport_data - passport_file - encrypted_passport_element - encrypted_credentials - passport_element_error - passport_element_error_data_field - passport_element_error_front_side - passport_element_error_reverse_side - passport_element_error_selfie - passport_element_error_file - passport_element_error_files - passport_element_error_translation_file - passport_element_error_translation_files - passport_element_error_unspecified + order_info + shipping_address Games ===== @@ -190,15 +187,6 @@ Games .. toctree:: :maxdepth: 1 + game_high_score game callback_game - game_high_score - - -Internal events -=============== - -.. toctree:: - :maxdepth: 1 - - error_event