Skip to content

Commit

Permalink
pyrofork: Fix some missing docs
Browse files Browse the repository at this point in the history
Signed-off-by: Yasir <[email protected]>
  • Loading branch information
yasirarism committed Jan 9, 2025
1 parent 84084c6 commit 2df6404
Show file tree
Hide file tree
Showing 11 changed files with 168 additions and 20 deletions.
48 changes: 30 additions & 18 deletions compiler/docs/compiler.py
Original file line number Diff line number Diff line change
Expand Up @@ -350,24 +350,24 @@ def get_title_list(s: str) -> list:
Payments
apply_gift_code
check_gift_code
convert_star_gift
convert_gift
create_invoice_link
get_payment_form
get_star_gifts
get_stars_transactions
get_stars_transactions_by_id
get_user_star_gifts_count
get_user_star_gifts
hide_star_gift
get_available_gifts
get_user_gifts_count
get_user_gifts
hide_gift
refund_star_payment
send_invoice
send_paid_media
send_paid_reaction
send_payment_form
send_star_gift
show_star_gift
transfer_star_gift
upgrade_star_gift
send_gift
show_gift
transfer_gift
upgrade_gift
""",
password="""
Password
Expand Down Expand Up @@ -396,11 +396,6 @@ def get_title_list(s: str) -> list:
get_bot_info
set_bot_info
get_collectible_item_info
get_available_gifts
get_user_gifts
sell_gift
send_gift
toggle_gift_is_saved
get_owned_bots
""",
business="""
Expand Down Expand Up @@ -527,6 +522,8 @@ def get_title_list(s: str) -> list:
Sticker
StickerSet
Game
Gift
GiftAttribute
Giveaway
GiveawayLaunched
GiveawayResult
Expand All @@ -539,7 +536,6 @@ def get_title_list(s: str) -> list:
PollOption
Dice
Reaction
StarGift
VideoChatScheduled
VideoChatStarted
VideoChatEnded
Expand All @@ -565,7 +561,6 @@ def get_title_list(s: str) -> list:
ScreenshotTaken
Wallpaper
WallpaperSettings
StarGiftAttribute
""",
stories="""
Stories
Expand All @@ -587,8 +582,6 @@ def get_title_list(s: str) -> list:
ExtendedMediaPreview
GiftCode
GiftedPremium
Gift
StarGift
InputStarsTransaction
Invoice
LabeledPrice
Expand Down Expand Up @@ -844,6 +837,25 @@ def get_title_list(s: str) -> list:
Story.reply_video_note
Story.reply_voice
""",
folder="""
Folder
Folder.delete
Folder.update
Folder.include_chat
Folder.exclude_chat
Folder.update_color
Folder.pin_chat
Folder.remove_chat
Folder.export_link
""",
gift="""
Gift
Gift.show
Gift.hide
Gift.convert
Gift.upgrade
Gift.transfer
""",
callback_query="""
Callback Query
CallbackQuery.answer
Expand Down
25 changes: 25 additions & 0 deletions compiler/docs/template/bound-methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,3 +140,28 @@ ChatJoinRequest

{chat_join_request_toctree}

Folder
---------------

.. hlist::
:columns: 2

{folder_hlist}

.. toctree::
:hidden:

{folder_toctree}

Gift
---------------

.. hlist::
:columns: 2

{gift_hlist}

.. toctree::
:hidden:

{gift_toctree}
15 changes: 14 additions & 1 deletion compiler/docs/template/methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,19 @@ Bots

{bots}

Payments
----

.. autosummary::
:nosignatures:

{payments}

.. toctree::
:hidden:

{payments}

Authorization
-------------

Expand Down Expand Up @@ -217,4 +230,4 @@ Learn more about how to use the raw API at :doc:`Advanced Usage <../../topics/ad
.. toctree::
:hidden:

{advanced}
{advanced}
41 changes: 40 additions & 1 deletion compiler/docs/template/types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,45 @@ InputMessageContent

{input_message_content}

ShippingQuery
-------------------

.. autosummary::
:nosignatures:

{shipping_query}

.. toctree::
:hidden:

{shipping_query}

PreCheckoutQuery
-------------------

.. autosummary::
:nosignatures:

{pre_checkout_query}

.. toctree::
:hidden:

{pre_checkout_query}

Payment
-------------------

.. autosummary::
:nosignatures:

{payment}

.. toctree::
:hidden:

{payment}

Authorization
-------------

Expand All @@ -175,4 +214,4 @@ Authorization
.. toctree::
:hidden:

{authorization}
{authorization}
8 changes: 8 additions & 0 deletions docs/source/api/enums/BusinessSchedule.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
BusinessSchedule
==========

.. autoclass:: pyrogram.enums.BusinessSchedule()
:members:

.. raw:: html
:file: ./cleanup.html
8 changes: 8 additions & 0 deletions docs/source/api/enums/ChatJoinType.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ChatJoinType
==========

.. autoclass:: pyrogram.enums.ChatJoinType()
:members:

.. raw:: html
:file: ./cleanup.html
8 changes: 8 additions & 0 deletions docs/source/api/enums/ClientPlatform.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ClientPlatform
==========

.. autoclass:: pyrogram.enums.ClientPlatform()
:members:

.. raw:: html
:file: ./cleanup.html
8 changes: 8 additions & 0 deletions docs/source/api/enums/GiftAttributeType.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
GiftAttributeType
==========

.. autoclass:: pyrogram.enums.GiftAttributeType()
:members:

.. raw:: html
:file: ./cleanup.html
8 changes: 8 additions & 0 deletions docs/source/api/enums/ProfileColor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ProfileColor
==========

.. autoclass:: pyrogram.enums.ProfileColor()
:members:

.. raw:: html
:file: ./cleanup.html
8 changes: 8 additions & 0 deletions docs/source/api/enums/ReplyColor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ReplyColor
==========

.. autoclass:: pyrogram.enums.ReplyColor()
:members:

.. raw:: html
:file: ./cleanup.html
11 changes: 11 additions & 0 deletions docs/source/api/enums/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,43 +16,54 @@ to apply only a valid value among the expected ones.
BusinessSchedule
ChatAction
ChatEventAction
ChatJoinType
ChatMemberStatus
ChatMembersFilter
ChatType
ClientPlatform
FolderColor
GiftAttributeType
ListenerTypes
MessageEntityType
MessageMediaType
MessageServiceType
MessagesFilter
ParseMode
PollType
ProfileColor
SentCodeType
NextCodeType
UserStatus
ReactionType
ReplyColor
StoriesPrivacyRules
StoryPrivacy

.. toctree::
:hidden:

BusinessSchedule
ChatAction
ChatEventAction
ChatJoinType
ChatMemberStatus
ChatMembersFilter
ChatType
ClientPlatform
FolderColor
GiftAttributeType
ListenerTypes
MessageEntityType
MessageMediaType
MessageServiceType
MessagesFilter
ParseMode
PollType
ProfileColor
SentCodeType
NextCodeType
UserStatus
ReactionType
ReplyColor
StoriesPrivacyRules
StoryPrivacy

0 comments on commit 2df6404

Please sign in to comment.