matthew/enhanced-discord.py
1
0
Fork 0
Code Issues 4 Pull Requests 21 Projects Releases Wiki Activity

Add attributetable and add some class-level sections.

Browse Source 
The extensions have yet to receive this treatment and CSS needs work,
but for now this is fine.
This commit is contained in:
Rapptz
2020-05-25 11:48:16 -04:00
parent 93f102ca90
commit 9b88c63163
5 changed files with 440 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

209
docs/api.rst
View File

@ -30,48 +30,116 @@ There are two main ways to query version information about the library. For guar
A string representation of the version. e.g. ``'1.0.0rc1'``. This is based
off of :pep:`440`.
Clients
--------
Client
-------
~~~~~~~
.. attributetable:: Client
.. autoclass:: Client
:members:
AutoShardedClient
~~~~~~~~~~~~~~~~~~
.. attributetable:: AutoShardedClient
.. autoclass:: AutoShardedClient
:members:
Application Info
------------------
AppInfo
~~~~~~~~
.. attributetable:: AppInfo
.. autoclass:: AppInfo()
:members:
Team
~~~~~
.. attributetable:: Team
.. autoclass:: Team()
:members:
TeamMember
~~~~~~~~~~~
.. attributetable:: TeamMember
.. autoclass:: TeamMember()
:members:
Voice
------
Voice Related
---------------
VoiceClient
~~~~~~~~~~~~
.. attributetable:: VoiceClient
.. autoclass:: VoiceClient()
:members:
VoiceProtocol
~~~~~~~~~~~~~~~
.. attributetable:: VoiceProtocol
.. autoclass:: VoiceProtocol
:members:
AudioSource
~~~~~~~~~~~~
.. attributetable:: AudioSource
.. autoclass:: AudioSource
:members:
PCMAudio
~~~~~~~~~
.. attributetable:: PCMAudio
.. autoclass:: PCMAudio
:members:
FFmpegAudio
~~~~~~~~~~~~
.. attributetable:: FFmpegAudio
.. autoclass:: FFmpegAudio
:members:
FFmpegPCMAudio
~~~~~~~~~~~~~~~
.. attributetable:: FFmpegPCMAudio
.. autoclass:: FFmpegPCMAudio
:members:
FFmpegOpusAudio
~~~~~~~~~~~~~~~~
.. attributetable:: FFmpegOpusAudio
.. autoclass:: FFmpegOpusAudio
:members:
PCMVolumeTransformer
~~~~~~~~~~~~~~~~~~~~~
.. attributetable:: PCMVolumeTransformer
.. autoclass:: PCMVolumeTransformer
:members:
@ -2149,9 +2217,19 @@ Working with :meth:`Guild.audit_logs` is a complicated process with a lot of mac
involved. The library attempts to make it easy to use and friendly. In order to accomplish
this goal, it must make use of a couple of data classes that aid in this goal.
AuditLogEntry
~~~~~~~~~~~~~~~
.. attributetable:: AuditLogEntry
.. autoclass:: AuditLogEntry
:members:
AuditLogChanges
~~~~~~~~~~~~~~~~~
.. attributetable:: AuditLogChanges
.. class:: AuditLogChanges
An audit log change set.
@ -2196,6 +2274,11 @@ this goal, it must make use of a couple of data classes that aid in this goal.
| ``None`` | No attributes are set. |
+----------------------------------------+--------------------------------------------------+
AuditLogDiff
~~~~~~~~~~~~~
.. attributetable:: AuditLogDiff
.. class:: AuditLogDiff
Represents an audit log "change" object. A change object has dynamic
@ -2541,6 +2624,8 @@ Webhook Support
discord.py offers support for creating, editing, and executing webhooks through the :class:`Webhook` class.
.. attributetable:: Webhook
.. autoclass:: Webhook
:members:
@ -2575,18 +2660,43 @@ They are mainly there for usage with :func:`py:isinstance` and :func:`py:issubcl
This library has a module related to abstract base classes, some of which are actually from the :doc:`abc <py:library/abc>` standard
module, others which are not.
Snowflake
~~~~~~~~~~
.. attributetable:: discord.abc.Snowflake
.. autoclass:: discord.abc.Snowflake
:members:
User
~~~~~
.. attributetable:: discord.abc.User
.. autoclass:: discord.abc.User
:members:
PrivateChannel
~~~~~~~~~~~~~~~
.. attributetable:: discord.abc.PrivateChannel
.. autoclass:: discord.abc.PrivateChannel
:members:
GuildChannel
~~~~~~~~~~~~~
.. attributetable:: discord.abc.GuildChannel
.. autoclass:: discord.abc.GuildChannel
:members:
Messageable
~~~~~~~~~~~~
.. attributetable:: discord.abc.Messageable
.. autoclass:: discord.abc.Messageable
:members:
:exclude-members: history, typing
@ -2597,6 +2707,11 @@ module, others which are not.
.. automethod:: discord.abc.Messageable.typing
:async-with:
Connectable
~~~~~~~~~~~~
.. attributetable:: discord.abc.Connectable
.. autoclass:: discord.abc.Connectable
.. _discord_api_models:
@ -2629,6 +2744,8 @@ the user of the library.
ClientUser
~~~~~~~~~~~~
.. attributetable:: ClientUser
.. autoclass:: ClientUser()
:members:
:inherited-members:
@ -2636,12 +2753,16 @@ ClientUser
Relationship
~~~~~~~~~~~~~~
.. attributetable:: Relationship
.. autoclass:: Relationship()
:members:
User
~~~~~
.. attributetable:: User
.. autoclass:: User()
:members:
:inherited-members:
@ -2656,18 +2777,24 @@ User
Attachment
~~~~~~~~~~~
.. attributetable:: Attachment
.. autoclass:: Attachment()
:members:
Asset
~~~~~
.. attributetable:: Asset
.. autoclass:: Asset()
:members:
Message
~~~~~~~
.. attributetable:: Message
.. autoclass:: Message()
:members:
@ -2681,6 +2808,8 @@ DeletedReferencedMessage
Reaction
~~~~~~~~~
.. attributetable:: Reaction
.. autoclass:: Reaction()
:members:
:exclude-members: users
@ -2691,18 +2820,24 @@ Reaction
CallMessage
~~~~~~~~~~~~
.. attributetable:: CallMessage
.. autoclass:: CallMessage()
:members:
GroupCall
~~~~~~~~~~
.. attributetable:: GroupCall
.. autoclass:: GroupCall()
:members:
Guild
~~~~~~
.. attributetable:: Guild
.. autoclass:: Guild()
:members:
:exclude-members: audit_logs
@ -2722,6 +2857,8 @@ Integration
Member
~~~~~~
.. attributetable:: Member
.. autoclass:: Member()
:members:
:inherited-members:
@ -2736,30 +2873,40 @@ Member
Spotify
~~~~~~~~
.. attributetable:: Spotify
.. autoclass:: Spotify()
:members:
VoiceState
~~~~~~~~~~~
.. attributetable:: VoiceState
.. autoclass:: VoiceState()
:members:
Emoji
~~~~~
.. attributetable:: Emoji
.. autoclass:: Emoji()
:members:
PartialEmoji
~~~~~~~~~~~~~~~~~~~~~~
.. attributetable:: PartialEmoji
.. autoclass:: PartialEmoji()
:members:
Role
~~~~~
.. attributetable:: Role
.. autoclass:: Role()
:members:
@ -2772,6 +2919,8 @@ RoleTags
TextChannel
~~~~~~~~~~~~
.. attributetable:: TextChannel
.. autoclass:: TextChannel()
:members:
:inherited-members:
@ -2786,6 +2935,8 @@ TextChannel
VoiceChannel
~~~~~~~~~~~~~
.. attributetable:: VoiceChannel
.. autoclass:: VoiceChannel()
:members:
:inherited-members:
@ -2793,6 +2944,8 @@ VoiceChannel
CategoryChannel
~~~~~~~~~~~~~~~~~
.. attributetable:: CategoryChannel
.. autoclass:: CategoryChannel()
:members:
:inherited-members:
@ -2800,6 +2953,8 @@ CategoryChannel
DMChannel
~~~~~~~~~
.. attributetable:: DMChannel
.. autoclass:: DMChannel()
:members:
:inherited-members:
@ -2814,6 +2969,8 @@ DMChannel
GroupChannel
~~~~~~~~~~~~
.. attributetable:: GroupChannel
.. autoclass:: GroupChannel()
:members:
:inherited-members:
@ -2828,18 +2985,24 @@ GroupChannel
PartialInviteGuild
~~~~~~~~~~~~~~~~~~~
.. attributetable:: PartialInviteGuild
.. autoclass:: PartialInviteGuild()
:members:
PartialInviteChannel
~~~~~~~~~~~~~~~~~~~~~
.. attributetable:: PartialInviteChannel
.. autoclass:: PartialInviteChannel()
:members:
Invite
~~~~~~~
.. attributetable:: Invite
.. autoclass:: Invite()
:members:
@ -2852,12 +3015,16 @@ Template
WidgetChannel
~~~~~~~~~~~~~~~
.. attributetable:: WidgetChannel
.. autoclass:: WidgetChannel()
:members:
WidgetMember
~~~~~~~~~~~~~
.. attributetable:: WidgetMember
.. autoclass:: WidgetMember()
:members:
:inherited-members:
@ -2865,6 +3032,8 @@ WidgetMember
Widget
~~~~~~~
.. attributetable:: Widget
.. autoclass:: Widget()
:members:
@ -2877,36 +3046,48 @@ Sticker
RawMessageDeleteEvent
~~~~~~~~~~~~~~~~~~~~~~~
.. attributetable:: RawMessageDeleteEvent
.. autoclass:: RawMessageDeleteEvent()
:members:
RawBulkMessageDeleteEvent
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. attributetable:: RawBulkMessageDeleteEvent
.. autoclass:: RawBulkMessageDeleteEvent()
:members:
RawMessageUpdateEvent
~~~~~~~~~~~~~~~~~~~~~~
.. attributetable:: RawMessageUpdateEvent
.. autoclass:: RawMessageUpdateEvent()
:members:
RawReactionActionEvent
~~~~~~~~~~~~~~~~~~~~~~~
.. attributetable:: RawReactionActionEvent
.. autoclass:: RawReactionActionEvent()
:members:
RawReactionClearEvent
~~~~~~~~~~~~~~~~~~~~~~
.. attributetable:: RawReactionClearEvent
.. autoclass:: RawReactionClearEvent()
:members:
RawReactionClearEmojiEvent
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. attributetable:: RawReactionClearEmojiEvent
.. autoclass:: RawReactionClearEmojiEvent()
:members:
@ -2937,12 +3118,16 @@ Object
Embed
~~~~~~
.. attributetable:: Embed
.. autoclass:: Embed
:members:
AllowedMentions
~~~~~~~~~~~~~~~~~
.. attributetable:: AllowedMentions
.. autoclass:: AllowedMentions
:members:
@ -2973,54 +3158,72 @@ MemberCacheFlags
File
~~~~~
.. attributetable:: File
.. autoclass:: File
:members:
Colour
~~~~~~
.. attributetable:: Colour
.. autoclass:: Colour
:members:
BaseActivity
~~~~~~~~~~~~~~
.. attributetable:: BaseActivity
.. autoclass:: BaseActivity
:members:
Activity
~~~~~~~~~
.. attributetable:: Activity
.. autoclass:: Activity
:members:
Game
~~~~~
.. attributetable:: Game
.. autoclass:: Game
:members:
Streaming
~~~~~~~~~~~
.. attributetable:: Streaming
.. autoclass:: Streaming
:members:
CustomActivity
~~~~~~~~~~~~~~~
.. attributetable:: CustomActivity
.. autoclass:: CustomActivity
:members:
Permissions
~~~~~~~~~~~~
.. attributetable:: Permissions
.. autoclass:: Permissions
:members:
PermissionOverwrite
~~~~~~~~~~~~~~~~~~~~
.. attributetable:: PermissionOverwrite
.. autoclass:: PermissionOverwrite
:members: