Browse Source

Add a new extlink for discord documentation

pull/7899/head
Rapptz 3 years ago
parent
commit
cf031f71b9
  1. 6
      discord/appinfo.py
  2. 8
      discord/embeds.py
  3. 2
      discord/raw_models.py
  4. 12
      discord/voice_client.py
  5. 2
      docs/api.rst
  6. 1
      docs/conf.py

6
discord/appinfo.py

@ -79,7 +79,7 @@ class AppInfo:
verify_key: :class:`str` verify_key: :class:`str`
The hex encoded key for verification in interactions and the The hex encoded key for verification in interactions and the
GameSDK's `GetTicket <https://discord.com/developers/docs/game-sdk/applications#getticket>`_. GameSDK's :ddocs:`GetTicket <game-sdk/applications#getticket>`.
.. versionadded:: 1.3 .. versionadded:: 1.3
@ -243,7 +243,7 @@ class PartialAppInfo:
A list of RPC origin URLs, if RPC is enabled. A list of RPC origin URLs, if RPC is enabled.
verify_key: :class:`str` verify_key: :class:`str`
The hex encoded key for verification in interactions and the The hex encoded key for verification in interactions and the
GameSDK's `GetTicket <https://discord.com/developers/docs/game-sdk/applications#getticket>`_. GameSDK's :ddocs:`GetTicket <game-sdk/applications#getticket>`.
terms_of_service_url: Optional[:class:`str`] terms_of_service_url: Optional[:class:`str`]
The application's terms of service URL, if set. The application's terms of service URL, if set.
privacy_policy_url: Optional[:class:`str`] privacy_policy_url: Optional[:class:`str`]
@ -302,7 +302,7 @@ class AppInstallParams:
Attributes Attributes
---------- ----------
scopes: List[:class:`str`] scopes: List[:class:`str`]
The list of `OAuth2 scopes <https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes>`_ The list of :ddocs:`OAuth2 scopes <topics/oauth2#shared-resources-oauth2-scopes>`
to add the application to a guild with. to add the application to a guild with.
permissions: :class:`Permissions` permissions: :class:`Permissions`
The permissions to give to application in the guild. The permissions to give to application in the guild.

8
discord/embeds.py

@ -122,7 +122,7 @@ class Embed:
The type of embed. Usually "rich". The type of embed. Usually "rich".
This can be set during initialisation. This can be set during initialisation.
Possible strings for embed types can be found on discord's Possible strings for embed types can be found on discord's
`api docs <https://discord.com/developers/docs/resources/channel#embed-object-embed-types>`_ :ddocs:`api docs <resources/channel#embed-object-embed-types>`
description: Optional[:class:`str`] description: Optional[:class:`str`]
The description of the embed. The description of the embed.
This can be set during initialisation. This can be set during initialisation.
@ -190,11 +190,7 @@ class Embed:
"""Converts a :class:`dict` to a :class:`Embed` provided it is in the """Converts a :class:`dict` to a :class:`Embed` provided it is in the
format that Discord expects it to be in. format that Discord expects it to be in.
You can find out about this format in the `official Discord documentation`__. You can find out about this format in the :ddocs:`official Discord documentation <resources/channel#embed-object>`.
.. _DiscordDocs: https://discord.com/developers/docs/resources/channel#embed-object
__ DiscordDocs_
Parameters Parameters
----------- -----------

2
discord/raw_models.py

@ -147,7 +147,7 @@ class RawMessageUpdateEvent(_RawReprMixin):
.. versionadded:: 1.7 .. versionadded:: 1.7
data: :class:`dict` data: :class:`dict`
The raw data given by the `gateway <https://discord.com/developers/docs/topics/gateway#message-update>`_ The raw data given by the :ddocs:`gateway <topics/gateway#message-update>`
cached_message: Optional[:class:`Message`] cached_message: Optional[:class:`Message`]
The cached message, if found in the internal message cache. Represents the message before The cached message, if found in the internal message cache. Represents the message before
it is modified by the data in :attr:`RawMessageUpdateEvent.data`. it is modified by the data in :attr:`RawMessageUpdateEvent.data`.

12
discord/voice_client.py

@ -124,11 +124,7 @@ class VoiceProtocol:
Parameters Parameters
------------ ------------
data: :class:`dict` data: :class:`dict`
The raw `voice state payload`__. The raw :ddocs:`voice state payload <resources/voice#voice-state-object>`.
.. _voice_state_update_payload: https://discord.com/developers/docs/resources/voice#voice-state-object
__ voice_state_update_payload_
""" """
raise NotImplementedError raise NotImplementedError
@ -141,11 +137,7 @@ class VoiceProtocol:
Parameters Parameters
------------ ------------
data: :class:`dict` data: :class:`dict`
The raw `voice server update payload`__. The raw :ddocs:`voice server update payload <topics/gateway#voice-server-update>`.
.. _voice_server_update_payload: https://discord.com/developers/docs/topics/gateway#voice-server-update-voice-server-update-event-fields
__ voice_server_update_payload_
""" """
raise NotImplementedError raise NotImplementedError

2
docs/api.rst

@ -879,7 +879,7 @@ Messages
will return a :class:`Message` object that represents the message before the content was modified. will return a :class:`Message` object that represents the message before the content was modified.
Due to the inherently raw nature of this event, the data parameter coincides with Due to the inherently raw nature of this event, the data parameter coincides with
the raw data given by the `gateway <https://discord.com/developers/docs/topics/gateway#message-update>`_. the raw data given by the :ddocs:`gateway <topics/gateway#message-update>`.
Since the data payload can be partial, care must be taken when accessing stuff in the dictionary. Since the data payload can be partial, care must be taken when accessing stuff in the dictionary.
One example of a common case of partial data is when the ``'content'`` key is inaccessible. This One example of a common case of partial data is when the ``'content'`` key is inaccessible. This

1
docs/conf.py

@ -51,6 +51,7 @@ autodoc_typehints = 'none'
extlinks = { extlinks = {
'issue': ('https://github.com/Rapptz/discord.py/issues/%s', 'GH-'), 'issue': ('https://github.com/Rapptz/discord.py/issues/%s', 'GH-'),
'ddocs': ('https://discord.com/developers/docs/%s', None),
} }
# Links used for cross-referencing stuff in other documentation # Links used for cross-referencing stuff in other documentation

Loading…
Cancel
Save