docs: make Supported Operations container collapsible (#1126)

DisnakeDev · Oct 26, 2023 · 3591556 · 3591556
1 parent ffb7526
commit 3591556
Show file tree

Hide file tree

Showing 39 changed files with 145 additions and 88 deletions.
diff --git a/changelog/1126.doc.rst b/changelog/1126.doc.rst
@@ -0,0 +1 @@
+Make all "Supported Operations" container elements collapsible.
diff --git a/disnake/activity.py b/disnake/activity.py
@@ -404,7 +404,7 @@ class Game(BaseActivity):
 
     This is typically displayed via **Playing** on the official Discord client.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -487,7 +487,7 @@ class Streaming(BaseActivity):
 
     This is typically displayed via **Streaming** on the official Discord client.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -597,7 +597,7 @@ def __hash__(self) -> int:
 class Spotify(_BaseActivity):
     """Represents a Spotify listening activity from Discord.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -770,7 +770,7 @@ def party_id(self) -> str:
 class CustomActivity(BaseActivity):
     """Represents a Custom activity from Discord.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/asset.py b/disnake/asset.py
@@ -164,7 +164,7 @@ async def to_file(
 class Asset(AssetMixin):
     """Represents a CDN asset on Discord.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: str(x)
 

diff --git a/disnake/audit_logs.py b/disnake/audit_logs.py
@@ -517,7 +517,7 @@ class AuditLogEntry(Hashable):
     You can retrieve these via :meth:`Guild.audit_logs`,
     or via the :func:`on_audit_log_entry_create` event.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/channel.py b/disnake/channel.py
@@ -103,7 +103,7 @@ async def _single_delete_strategy(messages: Iterable[Message]) -> None:
 class TextChannel(disnake.abc.Messageable, disnake.abc.GuildChannel, Hashable):
     """Represents a Discord guild text channel.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -1217,7 +1217,7 @@ def permissions_for(
 class VoiceChannel(disnake.abc.Messageable, VocalGuildChannel):
     """Represents a Discord guild voice channel.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -1871,7 +1871,7 @@ class StageChannel(disnake.abc.Messageable, VocalGuildChannel):
 
     .. versionadded:: 1.7
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -2696,7 +2696,7 @@ class CategoryChannel(disnake.abc.GuildChannel, Hashable):
 
     These are useful to group channels to logical compartments.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -3145,7 +3145,7 @@ class ForumChannel(disnake.abc.GuildChannel, Hashable):
 
     .. versionadded:: 2.5
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -4184,7 +4184,7 @@ def get_tag_by_name(self, name: str, /) -> Optional[ForumTag]:
 class DMChannel(disnake.abc.Messageable, Hashable):
     """Represents a Discord direct message channel.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -4347,7 +4347,7 @@ def get_partial_message(self, message_id: int, /) -> PartialMessage:
 class GroupChannel(disnake.abc.Messageable, Hashable):
     """Represents a Discord group channel.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -4506,7 +4506,7 @@ class PartialMessageable(disnake.abc.Messageable, Hashable):
 
     .. versionadded:: 2.0
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/colour.py b/disnake/colour.py
@@ -22,7 +22,7 @@ class Colour:
 
     There is an alias for this called Color.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/embeds.py b/disnake/embeds.py
@@ -112,7 +112,7 @@ class _EmbedAuthorProxy(Sized, Protocol):
 class Embed:
     """Represents a Discord embed.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/emoji.py b/disnake/emoji.py
@@ -28,7 +28,7 @@ class Emoji(_EmojiTag, AssetMixin):
     Depending on the way this object was created, some of the attributes can
     have a value of ``None``.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/ext/commands/flag_converter.py b/disnake/ext/commands/flag_converter.py
@@ -435,7 +435,7 @@ class FlagConverter(metaclass=FlagsMeta):
     how this converter works, check the appropriate
     :ref:`documentation <ext_commands_flag_converter>`.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: iter(x)
 

diff --git a/disnake/ext/commands/flags.py b/disnake/ext/commands/flags.py
@@ -25,7 +25,7 @@ class CommandSyncFlags(BaseFlags):
 
     .. versionadded:: 2.7
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/ext/commands/help.py b/disnake/ext/commands/help.py
@@ -48,7 +48,7 @@
 class Paginator:
     """A class that aids in paginating code blocks for Discord messages.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: len(x)
 

diff --git a/disnake/flags.py b/disnake/flags.py
@@ -329,7 +329,7 @@ class SystemChannelFlags(BaseFlags, inverted=True):
     to enable or disable.
     Arguments are applied in order, similar to :class:`Permissions`.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -491,7 +491,7 @@ class MessageFlags(BaseFlags):
 
     See :class:`SystemChannelFlags`.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -681,7 +681,7 @@ def is_voice_message(self):
 class PublicUserFlags(BaseFlags):
     """Wraps up the Discord User Public flags.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -930,7 +930,7 @@ class Intents(BaseFlags):
 
     .. versionadded:: 1.5
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -1617,7 +1617,7 @@ class MemberCacheFlags(BaseFlags):
 
     .. versionadded:: 1.5
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -1793,7 +1793,7 @@ def _voice_only(self):
 class ApplicationFlags(BaseFlags):
     """Wraps up the Discord Application flags.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -1968,7 +1968,7 @@ def application_command_badge(self):
 class ChannelFlags(BaseFlags):
     """Wraps up the Discord Channel flags.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -2081,7 +2081,7 @@ def require_tag(self):
 class AutoModKeywordPresets(ListBaseFlags):
     """Wraps up the pre-defined auto moderation keyword lists, provided by Discord.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -2194,7 +2194,7 @@ def slurs(self):
 class MemberFlags(BaseFlags):
     """Wraps up Discord Member flags.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -2296,7 +2296,7 @@ def started_onboarding(self):
 class RoleFlags(BaseFlags):
     """Wraps up Discord Role flags.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -2376,7 +2376,7 @@ def in_prompt(self):
 class AttachmentFlags(BaseFlags):
     """Wraps up Discord Attachment flags.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/guild.py b/disnake/guild.py
@@ -130,7 +130,7 @@ class Guild(Hashable):
 
     This is referred to as a "server" in the official Discord UI.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/guild_scheduled_event.py b/disnake/guild_scheduled_event.py
@@ -77,7 +77,7 @@ class GuildScheduledEvent(Hashable):
 
     .. versionadded:: 2.3
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/invite.py b/disnake/invite.py
@@ -48,7 +48,7 @@ class PartialInviteChannel:
     guild the :class:`Invite` resolves to.
 
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -137,7 +137,7 @@ class PartialInviteGuild:
     This model will be given when the user is not part of the
     guild the :class:`Invite` resolves to.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -256,7 +256,7 @@ class Invite(Hashable):
     Depending on the way this object was created, some of the attributes can
     have a value of ``None`` (see table below).
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/member.py b/disnake/member.py
@@ -212,7 +212,7 @@ class Member(disnake.abc.Messageable, _UserTag):
 
     This implements a lot of the functionality of :class:`User`.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/message.py b/disnake/message.py
@@ -220,7 +220,7 @@ async def _edit_handler(
 class Attachment(Hashable):
     """Represents an attachment from Discord.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: str(x)
 
@@ -766,7 +766,7 @@ def flatten_handlers(cls):
 class Message(Hashable):
     """Represents a message from Discord.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -2177,7 +2177,7 @@ class PartialMessage(Hashable):
 
     .. versionadded:: 1.6
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/object.py b/disnake/object.py
@@ -29,7 +29,7 @@ class Object(Hashable):
     receive this class rather than the actual data class. These cases are
     extremely rare.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/partial_emoji.py b/disnake/partial_emoji.py
@@ -38,7 +38,7 @@ class PartialEmoji(_EmojiTag, AssetMixin):
     - "Raw" data events such as :func:`on_raw_reaction_add`
     - Custom emoji that the bot cannot see from e.g. :attr:`Message.reactions`
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 

diff --git a/disnake/permissions.py b/disnake/permissions.py
@@ -76,7 +76,7 @@ class Permissions(BaseFlags):
         You can now use keyword arguments to initialize :class:`Permissions`
         similar to :meth:`update`.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
 
@@ -1036,7 +1036,7 @@ class PermissionOverwrite:
     The values supported by this are the same as :class:`Permissions`
     with the added possibility of it being set to ``None``.
 
-    .. container:: operations
+    .. collapse:: operations
 
         .. describe:: x == y
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Make all "Supported Operations" container elements collapsible.