From a044360f2369fbc13a2db0cb1c97f1ac7326e150 Mon Sep 17 00:00:00 2001
From: ChrisLovering
Date: Thu, 18 Aug 2022 15:13:27 +0000
Subject: Deploying to docs from @
python-discord/bot-core@127d0efa219d29e15bd71339d0d2517945aed57c π
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
v7.4.0/.buildinfo | 2 +-
v7.4.0/.doctrees/changelog.doctree | Bin 85470 -> 85470 bytes
v7.4.0/.doctrees/environment.pickle | Bin 2667931 -> 2669147 bytes
v7.4.0/.doctrees/index.doctree | Bin 5445 -> 5445 bytes
.../.doctrees/output/botcore.async_stats.doctree | Bin 18861 -> 18861 bytes
v7.4.0/.doctrees/output/botcore.doctree | Bin 61096 -> 61096 bytes
v7.4.0/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes
v7.4.0/.doctrees/output/botcore.site_api.doctree | Bin 65280 -> 65280 bytes
.../.doctrees/output/botcore.utils.caching.doctree | Bin 16603 -> 16603 bytes
.../.doctrees/output/botcore.utils.channel.doctree | Bin 17549 -> 17549 bytes
v7.4.0/.doctrees/output/botcore.utils.doctree | Bin 14018 -> 14018 bytes
.../output/botcore.utils.interactions.doctree | Bin 35386 -> 35386 bytes
.../.doctrees/output/botcore.utils.logging.doctree | Bin 18145 -> 18145 bytes
.../.doctrees/output/botcore.utils.members.doctree | Bin 17417 -> 17417 bytes
.../.doctrees/output/botcore.utils.regex.doctree | Bin 9019 -> 9019 bytes
.../output/botcore.utils.scheduling.doctree | Bin 55134 -> 55134 bytes
v7.4.0/_static/pygments.css | 3 +++
v7.4.0/changelog.html | 4 ++++
v7.4.0/genindex.html | 4 ++++
v7.4.0/index.html | 4 ++++
v7.4.0/output/botcore.async_stats.html | 4 ++++
v7.4.0/output/botcore.exts.html | 4 ++++
v7.4.0/output/botcore.html | 8 ++++++--
v7.4.0/output/botcore.site_api.html | 4 ++++
v7.4.0/output/botcore.utils.caching.html | 4 ++++
v7.4.0/output/botcore.utils.channel.html | 18 +++++++++++-------
v7.4.0/output/botcore.utils.html | 6 +++++-
v7.4.0/output/botcore.utils.interactions.html | 12 ++++++++----
v7.4.0/output/botcore.utils.logging.html | 4 ++++
v7.4.0/output/botcore.utils.members.html | 18 +++++++++++-------
v7.4.0/output/botcore.utils.regex.html | 4 ++++
v7.4.0/output/botcore.utils.scheduling.html | 4 ++++
v7.4.0/py-modindex.html | 4 ++++
v7.4.0/search.html | 4 ++++
v7.4.0/versions.html | 10 ++++++++++
35 files changed, 103 insertions(+), 22 deletions(-)
(limited to 'v7.4.0')
diff --git a/v7.4.0/.buildinfo b/v7.4.0/.buildinfo
index 76908b82..765f7f2d 100644
--- a/v7.4.0/.buildinfo
+++ b/v7.4.0/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 25f73e0fa99e7b485d80b32b70b7dc78
+config: 9b2a31d646b0a847325f810aa2fbb868
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v7.4.0/.doctrees/changelog.doctree b/v7.4.0/.doctrees/changelog.doctree
index 7ea3eb53..35d5aabb 100644
Binary files a/v7.4.0/.doctrees/changelog.doctree and b/v7.4.0/.doctrees/changelog.doctree differ
diff --git a/v7.4.0/.doctrees/environment.pickle b/v7.4.0/.doctrees/environment.pickle
index 37799851..44951b91 100644
Binary files a/v7.4.0/.doctrees/environment.pickle and b/v7.4.0/.doctrees/environment.pickle differ
diff --git a/v7.4.0/.doctrees/index.doctree b/v7.4.0/.doctrees/index.doctree
index cf14ab5d..c7687e3c 100644
Binary files a/v7.4.0/.doctrees/index.doctree and b/v7.4.0/.doctrees/index.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.async_stats.doctree b/v7.4.0/.doctrees/output/botcore.async_stats.doctree
index 4c423973..68223cbd 100644
Binary files a/v7.4.0/.doctrees/output/botcore.async_stats.doctree and b/v7.4.0/.doctrees/output/botcore.async_stats.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.doctree b/v7.4.0/.doctrees/output/botcore.doctree
index 86685ff6..c58d41c9 100644
Binary files a/v7.4.0/.doctrees/output/botcore.doctree and b/v7.4.0/.doctrees/output/botcore.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.exts.doctree b/v7.4.0/.doctrees/output/botcore.exts.doctree
index d5db9cb9..c3f28f34 100644
Binary files a/v7.4.0/.doctrees/output/botcore.exts.doctree and b/v7.4.0/.doctrees/output/botcore.exts.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.site_api.doctree b/v7.4.0/.doctrees/output/botcore.site_api.doctree
index 4dc1bf12..d59c5990 100644
Binary files a/v7.4.0/.doctrees/output/botcore.site_api.doctree and b/v7.4.0/.doctrees/output/botcore.site_api.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.utils.caching.doctree b/v7.4.0/.doctrees/output/botcore.utils.caching.doctree
index 1ad4d5cf..ae2d39a5 100644
Binary files a/v7.4.0/.doctrees/output/botcore.utils.caching.doctree and b/v7.4.0/.doctrees/output/botcore.utils.caching.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.utils.channel.doctree b/v7.4.0/.doctrees/output/botcore.utils.channel.doctree
index b39c1c66..412be71d 100644
Binary files a/v7.4.0/.doctrees/output/botcore.utils.channel.doctree and b/v7.4.0/.doctrees/output/botcore.utils.channel.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.utils.doctree b/v7.4.0/.doctrees/output/botcore.utils.doctree
index 233cbeb1..72e3ed43 100644
Binary files a/v7.4.0/.doctrees/output/botcore.utils.doctree and b/v7.4.0/.doctrees/output/botcore.utils.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree b/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree
index aed4529e..86d78e8f 100644
Binary files a/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree and b/v7.4.0/.doctrees/output/botcore.utils.interactions.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.utils.logging.doctree b/v7.4.0/.doctrees/output/botcore.utils.logging.doctree
index ce607a16..426bfb7d 100644
Binary files a/v7.4.0/.doctrees/output/botcore.utils.logging.doctree and b/v7.4.0/.doctrees/output/botcore.utils.logging.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.utils.members.doctree b/v7.4.0/.doctrees/output/botcore.utils.members.doctree
index 7de65055..a2435024 100644
Binary files a/v7.4.0/.doctrees/output/botcore.utils.members.doctree and b/v7.4.0/.doctrees/output/botcore.utils.members.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.utils.regex.doctree b/v7.4.0/.doctrees/output/botcore.utils.regex.doctree
index e166da98..aa6cff41 100644
Binary files a/v7.4.0/.doctrees/output/botcore.utils.regex.doctree and b/v7.4.0/.doctrees/output/botcore.utils.regex.doctree differ
diff --git a/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree b/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree
index bde8e46a..f59a3766 100644
Binary files a/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree and b/v7.4.0/.doctrees/output/botcore.utils.scheduling.doctree differ
diff --git a/v7.4.0/_static/pygments.css b/v7.4.0/_static/pygments.css
index 053cfd3d..75471509 100644
--- a/v7.4.0/_static/pygments.css
+++ b/v7.4.0/_static/pygments.css
@@ -54,6 +54,7 @@
.highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #000000 } /* Name.Variable */
.highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */
+.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */
.highlight .w { color: #f8f8f8 } /* Text.Whitespace */
.highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */
@@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */
body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */
body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */
body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */
+body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */
body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */
body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */
body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */
@@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert
body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */
body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */
body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */
+body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */
body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */
body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */
body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */
diff --git a/v7.4.0/changelog.html b/v7.4.0/changelog.html
index da8052b6..596081a3 100644
--- a/v7.4.0/changelog.html
+++ b/v7.4.0/changelog.html
@@ -205,6 +205,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.4.0/genindex.html b/v7.4.0/genindex.html
index 56a2c752..7c5bc1ff 100644
--- a/v7.4.0/genindex.html
+++ b/v7.4.0/genindex.html
@@ -203,6 +203,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.4.0/index.html b/v7.4.0/index.html
index 7db94bca..1591bc50 100644
--- a/v7.4.0/index.html
+++ b/v7.4.0/index.html
@@ -205,6 +205,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.4.0/output/botcore.async_stats.html b/v7.4.0/output/botcore.async_stats.html
index fd57d038..dca1852d 100644
--- a/v7.4.0/output/botcore.async_stats.html
+++ b/v7.4.0/output/botcore.async_stats.html
@@ -205,6 +205,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.4.0/output/botcore.exts.html b/v7.4.0/output/botcore.exts.html
index f0ba2442..42704513 100644
--- a/v7.4.0/output/botcore.exts.html
+++ b/v7.4.0/output/botcore.exts.html
@@ -205,6 +205,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.4.0/output/botcore.html b/v7.4.0/output/botcore.html
index bf11abee..4518b68a 100644
--- a/v7.4.0/output/botcore.html
+++ b/v7.4.0/output/botcore.html
@@ -205,6 +205,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
@@ -329,7 +333,7 @@
-
class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]
-Bases: Bot
+Bases: Bot
A sub-class that implements many common features that Python Discord bots use.
-
@@ -460,7 +464,7 @@ will not be set and guild_available_but_cache_empty event will be e
To remove them, either remove the entire command or manually edit bot.all_commands.
- Return type:
-Optional
[Command
]
+Optional
[Command
]
diff --git a/v7.4.0/output/botcore.site_api.html b/v7.4.0/output/botcore.site_api.html
index f962f4cb..dd0261c4 100644
--- a/v7.4.0/output/botcore.site_api.html
+++ b/v7.4.0/output/botcore.site_api.html
@@ -205,6 +205,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.4.0/output/botcore.utils.caching.html b/v7.4.0/output/botcore.utils.caching.html
index 5363af4c..b477e561 100644
--- a/v7.4.0/output/botcore.utils.caching.html
+++ b/v7.4.0/output/botcore.utils.caching.html
@@ -205,6 +205,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
diff --git a/v7.4.0/output/botcore.utils.channel.html b/v7.4.0/output/botcore.utils.channel.html
index 6024d60a..e03e3370 100644
--- a/v7.4.0/output/botcore.utils.channel.html
+++ b/v7.4.0/output/botcore.utils.channel.html
@@ -205,6 +205,10 @@
main
+
+ v8.1.0
+
+
v8.0.0-beta.4
@@ -333,20 +337,20 @@
- Parameters:
-
- Raises:
-
- Return type:
-GuildChannel
+GuildChannel
- Returns:
The channel from the ID.
@@ -361,7 +365,7 @@
- Parameters:
-channel (TextChannel
) β The channel to check.
+channel (TextChannel
) β The channel to check.
category_id (int
) β The category to check for.
diff --git a/v7.4.0/output/botcore.utils.html b/v7.4.0/output/botcore.utils.html
index 1b6ffaab..0db22c79 100644
--- a/v7.4.0/output/botcore.utils.html
+++ b/v7.4.0/output/botcore.utils.html
@@ -205,6 +205,10 @@
main
+
-
+ v8.1.0
+
+
-
v8.0.0-beta.4
@@ -331,7 +335,7 @@
apply_monkey_patches()[source]
Applies all common monkey patches for our bots.
-- Patches
discord.ext.commands.Command
and discord.ext.commands.Group
to support root aliases. A root_aliases
keyword argument is added to these two objects, which is a sequence of alias names
+
- Patches
discord.ext.commands.Command
and discord.ext.commands.Group
to support root aliases. A root_aliases
keyword argument is added to these two objects, which is a sequence of alias names
that will act as top-level groups rather than being aliases of the commandβs group.
Itβs stored as an attribute also named root_aliases
diff --git a/v7.4.0/output/botcore.utils.interactions.html b/v7.4.0/output/botcore.utils.interactions.html
index cc0387ae..9a934d46 100644
--- a/v7.4.0/output/botcore.utils.interactions.html
+++ b/v7.4.0/output/botcore.utils.interactions.html
@@ -205,6 +205,10 @@
main
+
-
+ v8.1.0
+
+
-
v8.0.0-beta.4
@@ -328,7 +332,7 @@
-
class DeleteMessageButton(*, style=<ButtonStyle.secondary: 2>, label='Delete', **kwargs)[source]
-Bases: Button
+Bases: Button
A button that can be added to a view to delete the message containing the view on click.
This button itself carries out no interaction checks, these should be done by the parent view.
See botcore.utils.interactions.ViewWithUserAndRoleCheck
for a view that implements basic checks.
@@ -361,7 +365,7 @@
-
class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]
-Bases: View
+Bases: View
A view that allows the original invoker and moderators to interact with it.
- Parameters:
@@ -370,7 +374,7 @@
allowed_roles (Sequence
[int
]) β A sequence of role ids that are allowed to interact with the view.
timeout (Optional
[float
]) β Timeout in seconds from last interaction with the UI before no longer accepting input.
If None
then there is no timeout.
-message (Optional
[Message
]) β The message to remove the view from on timeout. This can also be set with
+
message (Optional
[Message
]) β The message to remove the view from on timeout. This can also be set with
view.message = await ctx.send( ... )`
, or similar, after the view is instantiated.
@@ -386,7 +390,7 @@ If NoneEnsure the user clicking the button is the view invoker, or a moderator.
- Parameters:
-interaction (Interaction
) β The interaction that occurred.
+interaction (Interaction
) β The interaction that occurred.
- Return type:
bool
diff --git a/v7.4.0/output/botcore.utils.logging.html b/v7.4.0/output/botcore.utils.logging.html
index 887b85ee..9c4ee67d 100644
--- a/v7.4.0/output/botcore.utils.logging.html
+++ b/v7.4.0/output/botcore.utils.logging.html
@@ -205,6 +205,10 @@
main
+ -
+ v8.1.0
+
+
-
v8.0.0-beta.4
diff --git a/v7.4.0/output/botcore.utils.members.html b/v7.4.0/output/botcore.utils.members.html
index 787556e1..a4f7b401 100644
--- a/v7.4.0/output/botcore.utils.members.html
+++ b/v7.4.0/output/botcore.utils.members.html
@@ -205,6 +205,10 @@
main
+ -
+ v8.1.0
+
+
-
v8.0.0-beta.4
@@ -325,17 +329,17 @@
members
-Useful helper functions for interactin with discord.Member
objects.
+Useful helper functions for interactin with discord.Member
objects.
-
async get_or_fetch_member(guild, member_id)[source]
Attempt to get a member from cache; on failure fetch from the API.
- Return type:
-Optional
[Member
]
+Optional
[Member
]
- Returns:
-The discord.Member
or None
to indicate the member could not be found.
+The discord.Member
or None
to indicate the member could not be found.
@@ -345,13 +349,13 @@
async handle_role_change(member, coro, role)[source]
Await the given coro
with role
as the sole argument.
Handle errors that we expect to be raised from
-discord.Member.add_roles
and discord.Member.remove_roles
.
+discord.Member.add_roles
and discord.Member.remove_roles
.
- Parameters:
-
- Return type:
diff --git a/v7.4.0/output/botcore.utils.regex.html b/v7.4.0/output/botcore.utils.regex.html
index c838fff0..65321f65 100644
--- a/v7.4.0/output/botcore.utils.regex.html
+++ b/v7.4.0/output/botcore.utils.regex.html
@@ -205,6 +205,10 @@
main
+
-
+ v8.1.0
+
+
-
v8.0.0-beta.4
diff --git a/v7.4.0/output/botcore.utils.scheduling.html b/v7.4.0/output/botcore.utils.scheduling.html
index cf1a5388..2180de6d 100644
--- a/v7.4.0/output/botcore.utils.scheduling.html
+++ b/v7.4.0/output/botcore.utils.scheduling.html
@@ -205,6 +205,10 @@
main
+ -
+ v8.1.0
+
+
-
v8.0.0-beta.4
diff --git a/v7.4.0/py-modindex.html b/v7.4.0/py-modindex.html
index c08cd1b4..e1d8ab95 100644
--- a/v7.4.0/py-modindex.html
+++ b/v7.4.0/py-modindex.html
@@ -203,6 +203,10 @@
main
+ -
+ v8.1.0
+
+
-
v8.0.0-beta.4
diff --git a/v7.4.0/search.html b/v7.4.0/search.html
index 49de37f7..f2a9438d 100644
--- a/v7.4.0/search.html
+++ b/v7.4.0/search.html
@@ -202,6 +202,10 @@
main
+ -
+ v8.1.0
+
+
-
v8.0.0-beta.4
diff --git a/v7.4.0/versions.html b/v7.4.0/versions.html
index 74ef7468..deb83324 100644
--- a/v7.4.0/versions.html
+++ b/v7.4.0/versions.html
@@ -204,6 +204,10 @@
main
+ -
+ v8.1.0
+
+
-
v8.0.0-beta.4
@@ -335,6 +339,12 @@
- latest
+ -
+ v8.1.0
+
+
+
+
-
v8.0.0-beta.4
--
cgit v1.2.3