[commands] Make documentation use new attributetable
This commit is contained in:
parent
4ef6d7ec1e
commit
17b49c5a46
@ -7,16 +7,29 @@ The following section outlines the API of discord.py's command extension module.
|
|||||||
|
|
||||||
.. _ext_commands_api_bot:
|
.. _ext_commands_api_bot:
|
||||||
|
|
||||||
|
Bots
|
||||||
|
------
|
||||||
|
|
||||||
Bot
|
Bot
|
||||||
----
|
~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.Bot
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.Bot
|
.. autoclass:: discord.ext.commands.Bot
|
||||||
:members:
|
:members:
|
||||||
:inherited-members:
|
:inherited-members:
|
||||||
|
|
||||||
|
AutoShardedBot
|
||||||
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.AutoShardedBot
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.AutoShardedBot
|
.. autoclass:: discord.ext.commands.AutoShardedBot
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
Prefix Helpers
|
||||||
|
----------------
|
||||||
|
|
||||||
.. autofunction:: discord.ext.commands.when_mentioned
|
.. autofunction:: discord.ext.commands.when_mentioned
|
||||||
|
|
||||||
.. autofunction:: discord.ext.commands.when_mentioned_or
|
.. autofunction:: discord.ext.commands.when_mentioned_or
|
||||||
@ -64,21 +77,39 @@ are custom to the command extension module.
|
|||||||
|
|
||||||
.. _ext_commands_api_command:
|
.. _ext_commands_api_command:
|
||||||
|
|
||||||
Command
|
Commands
|
||||||
--------
|
----------
|
||||||
|
|
||||||
|
Decorators
|
||||||
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
.. autofunction:: discord.ext.commands.command
|
.. autofunction:: discord.ext.commands.command
|
||||||
|
|
||||||
.. autofunction:: discord.ext.commands.group
|
.. autofunction:: discord.ext.commands.group
|
||||||
|
|
||||||
|
Command
|
||||||
|
~~~~~~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.Command
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.Command
|
.. autoclass:: discord.ext.commands.Command
|
||||||
:members:
|
:members:
|
||||||
:special-members: __call__
|
:special-members: __call__
|
||||||
|
|
||||||
|
Group
|
||||||
|
~~~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.Group
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.Group
|
.. autoclass:: discord.ext.commands.Group
|
||||||
:members:
|
:members:
|
||||||
:inherited-members:
|
:inherited-members:
|
||||||
|
|
||||||
|
GroupMixin
|
||||||
|
~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.GroupMixin
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.GroupMixin
|
.. autoclass:: discord.ext.commands.GroupMixin
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
@ -87,28 +118,58 @@ Command
|
|||||||
Cogs
|
Cogs
|
||||||
------
|
------
|
||||||
|
|
||||||
|
Cog
|
||||||
|
~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.Cog
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.Cog
|
.. autoclass:: discord.ext.commands.Cog
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
CogMeta
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.CogMeta
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.CogMeta
|
.. autoclass:: discord.ext.commands.CogMeta
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
.. _ext_commands_help_command:
|
.. _ext_commands_help_command:
|
||||||
|
|
||||||
Help Commands
|
Help Commands
|
||||||
-----------------
|
---------------
|
||||||
|
|
||||||
|
HelpCommand
|
||||||
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.HelpCommand
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.HelpCommand
|
.. autoclass:: discord.ext.commands.HelpCommand
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
DefaultHelpCommand
|
||||||
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.DefaultHelpCommand
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.DefaultHelpCommand
|
.. autoclass:: discord.ext.commands.DefaultHelpCommand
|
||||||
:members:
|
:members:
|
||||||
:exclude-members: send_bot_help, send_cog_help, send_group_help, send_command_help, prepare_help_command
|
:exclude-members: send_bot_help, send_cog_help, send_group_help, send_command_help, prepare_help_command
|
||||||
|
|
||||||
|
MinimalHelpCommand
|
||||||
|
~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.MinimalHelpCommand
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.MinimalHelpCommand
|
.. autoclass:: discord.ext.commands.MinimalHelpCommand
|
||||||
:members:
|
:members:
|
||||||
:exclude-members: send_bot_help, send_cog_help, send_group_help, send_command_help, prepare_help_command
|
:exclude-members: send_bot_help, send_cog_help, send_group_help, send_command_help, prepare_help_command
|
||||||
|
|
||||||
|
Paginator
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.Paginator
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.Paginator
|
.. autoclass:: discord.ext.commands.Paginator
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
@ -190,6 +251,8 @@ Checks
|
|||||||
Context
|
Context
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
.. attributetable:: discord.ext.commands.Context
|
||||||
|
|
||||||
.. autoclass:: discord.ext.commands.Context
|
.. autoclass:: discord.ext.commands.Context
|
||||||
:members:
|
:members:
|
||||||
:inherited-members:
|
:inherited-members:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user