From 2e165e673111c448ed1983c5747cc8f483a72732 Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Sat, 23 Jul 2022 13:29:55 +0000 Subject: Deploying to docs from @ python-discord/bot-core@7f8d2abcc0830268774a8b90c12da8b52be1398b 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- v7.2.0/.buildinfo | 2 +- v7.2.0/.doctrees/changelog.doctree | Bin 67877 -> 67877 bytes v7.2.0/.doctrees/environment.pickle | Bin 2642390 -> 2643268 bytes v7.2.0/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.2.0/.doctrees/output/botcore.doctree | Bin 62401 -> 62337 bytes v7.2.0/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.2.0/.doctrees/output/botcore.site_api.doctree | Bin 65215 -> 65215 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.2.0/.doctrees/output/botcore.utils.doctree | Bin 13965 -> 13968 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes v7.2.0/changelog.html | 4 +++ v7.2.0/genindex.html | 4 +++ v7.2.0/index.html | 4 +++ v7.2.0/output/botcore.async_stats.html | 4 +++ v7.2.0/output/botcore.exts.html | 4 +++ v7.2.0/output/botcore.html | 36 ++++++++++++--------- v7.2.0/output/botcore.site_api.html | 4 +++ v7.2.0/output/botcore.utils.caching.html | 4 +++ v7.2.0/output/botcore.utils.channel.html | 4 +++ v7.2.0/output/botcore.utils.html | 6 +++- v7.2.0/output/botcore.utils.logging.html | 4 +++ v7.2.0/output/botcore.utils.members.html | 4 +++ v7.2.0/output/botcore.utils.regex.html | 4 +++ v7.2.0/output/botcore.utils.scheduling.html | 4 +++ v7.2.0/py-modindex.html | 4 +++ v7.2.0/search.html | 4 +++ v7.2.0/versions.html | 10 ++++++ 32 files changed, 92 insertions(+), 18 deletions(-) (limited to 'v7.2.0') diff --git a/v7.2.0/.buildinfo b/v7.2.0/.buildinfo index 5510b4d1..d32f433e 100644 --- a/v7.2.0/.buildinfo +++ b/v7.2.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: 6e770fe4a52371244ca114fe3064764a +config: 77728cc6a8022860f8496b7f26583fd8 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.2.0/.doctrees/changelog.doctree b/v7.2.0/.doctrees/changelog.doctree index 185e7b2f..2c61dc64 100644 Binary files a/v7.2.0/.doctrees/changelog.doctree and b/v7.2.0/.doctrees/changelog.doctree differ diff --git a/v7.2.0/.doctrees/environment.pickle b/v7.2.0/.doctrees/environment.pickle index 1fdf876d..b29c066f 100644 Binary files a/v7.2.0/.doctrees/environment.pickle and b/v7.2.0/.doctrees/environment.pickle differ diff --git a/v7.2.0/.doctrees/index.doctree b/v7.2.0/.doctrees/index.doctree index 44cc7e84..eb7e2b03 100644 Binary files a/v7.2.0/.doctrees/index.doctree and b/v7.2.0/.doctrees/index.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.async_stats.doctree b/v7.2.0/.doctrees/output/botcore.async_stats.doctree index f412de42..a6b3bede 100644 Binary files a/v7.2.0/.doctrees/output/botcore.async_stats.doctree and b/v7.2.0/.doctrees/output/botcore.async_stats.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.doctree b/v7.2.0/.doctrees/output/botcore.doctree index 1ac76b82..add6a73e 100644 Binary files a/v7.2.0/.doctrees/output/botcore.doctree and b/v7.2.0/.doctrees/output/botcore.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.exts.doctree b/v7.2.0/.doctrees/output/botcore.exts.doctree index 01f50697..2c3ba569 100644 Binary files a/v7.2.0/.doctrees/output/botcore.exts.doctree and b/v7.2.0/.doctrees/output/botcore.exts.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.site_api.doctree b/v7.2.0/.doctrees/output/botcore.site_api.doctree index d77ff8dc..7e9bba62 100644 Binary files a/v7.2.0/.doctrees/output/botcore.site_api.doctree and b/v7.2.0/.doctrees/output/botcore.site_api.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.caching.doctree b/v7.2.0/.doctrees/output/botcore.utils.caching.doctree index 168203bf..b3a48e79 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.caching.doctree and b/v7.2.0/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.channel.doctree b/v7.2.0/.doctrees/output/botcore.utils.channel.doctree index 2da869bd..97c302b5 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.channel.doctree and b/v7.2.0/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.doctree b/v7.2.0/.doctrees/output/botcore.utils.doctree index b630851e..6f15cea0 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.doctree and b/v7.2.0/.doctrees/output/botcore.utils.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.logging.doctree b/v7.2.0/.doctrees/output/botcore.utils.logging.doctree index e3b27363..74e39a50 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.logging.doctree and b/v7.2.0/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.members.doctree b/v7.2.0/.doctrees/output/botcore.utils.members.doctree index 64e5e906..cd17181d 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.members.doctree and b/v7.2.0/.doctrees/output/botcore.utils.members.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.regex.doctree b/v7.2.0/.doctrees/output/botcore.utils.regex.doctree index 3e196d0d..37915a6d 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.regex.doctree and b/v7.2.0/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree b/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree index c81a34f8..bbdb3e1c 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree and b/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/v7.2.0/changelog.html b/v7.2.0/changelog.html index 0e8df2d9..c3dc15c3 100644 --- a/v7.2.0/changelog.html +++ b/v7.2.0/changelog.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/genindex.html b/v7.2.0/genindex.html index 6b4310b3..f06aa856 100644 --- a/v7.2.0/genindex.html +++ b/v7.2.0/genindex.html @@ -206,6 +206,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/index.html b/v7.2.0/index.html index b069e4f9..9958a633 100644 --- a/v7.2.0/index.html +++ b/v7.2.0/index.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/output/botcore.async_stats.html b/v7.2.0/output/botcore.async_stats.html index 8956d854..4a2514c1 100644 --- a/v7.2.0/output/botcore.async_stats.html +++ b/v7.2.0/output/botcore.async_stats.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/output/botcore.exts.html b/v7.2.0/output/botcore.exts.html index 8deb8a33..0ba30dc7 100644 --- a/v7.2.0/output/botcore.exts.html +++ b/v7.2.0/output/botcore.exts.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/output/botcore.html b/v7.2.0/output/botcore.html index 7adb48aa..e1d73088 100644 --- a/v7.2.0/output/botcore.html +++ b/v7.2.0/output/botcore.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • @@ -299,12 +303,12 @@

    Useful utilities and tools for Discord bot development.

    -class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#
    +class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#

    Bases: Bot

    A sub-class that implements many common features that Python Discord bots use.

    -__init__(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#
    +__init__(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]#

    Initialise the base bot instance.

    Parameters:
    @@ -323,7 +327,7 @@ a dummy statsd client will be created.

    -async add_cog(cog)[source]#
    +async add_cog(cog)[source]#

    Add the given cog to the bot and log the operation.

    Return type:
    @@ -334,7 +338,7 @@ a dummy statsd client will be created.

    -add_command(command)[source]#
    +add_command(command)[source]#

    Add command as normal and then add its root aliases to the bot.

    Return type:
    @@ -345,7 +349,7 @@ a dummy statsd client will be created.

    -clear()[source]#
    +clear()[source]#

    Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.

    Return type:
    @@ -356,7 +360,7 @@ a dummy statsd client will be created.

    -async close()[source]#
    +async close()[source]#

    Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.

    Return type:
    @@ -367,7 +371,7 @@ a dummy statsd client will be created.

    -async load_extensions(module)[source]#
    +async load_extensions(module)[source]#

    Load all the extensions within the given module and save them to self.all_extensions.

    This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

    @@ -379,7 +383,7 @@ a dummy statsd client will be created.

    -async log_to_dev_log(message)[source]#
    +async log_to_dev_log(message)[source]#

    Log the given message to #dev-log.

    Return type:
    @@ -390,7 +394,7 @@ a dummy statsd client will be created.

    -async on_guild_available(guild)[source]#
    +async on_guild_available(guild)[source]#

    Set the internal guild available event when self.guild_id becomes available.

    If the cache appears to still be empty (no members, no channels, or no roles), the event will not be set and guild_available_but_cache_empty event will be emitted.

    @@ -403,7 +407,7 @@ will not be set and guild_available_but_cache_empty event will be e
    -async on_guild_unavailable(guild)[source]#
    +async on_guild_unavailable(guild)[source]#

    Clear the internal guild available event when self.guild_id becomes unavailable.

    Return type:
    @@ -414,7 +418,7 @@ will not be set and guild_available_but_cache_empty event will be e
    -async ping_services()[source]#
    +async ping_services()[source]#

    Ping all required services on setup to ensure they are up before starting.

    Return type:
    @@ -425,7 +429,7 @@ will not be set and guild_available_but_cache_empty event will be e
    -remove_command(name)[source]#
    +remove_command(name)[source]#

    Remove a command/alias as normal and then remove its root aliases from the bot.

    Individual root aliases cannot be removed by this function. To remove them, either remove the entire command or manually edit bot.all_commands.

    @@ -438,7 +442,7 @@ To remove them, either remove the entire command or manually edit bot.all_
    -async setup_hook()[source]#
    +async setup_hook()[source]#

    An async init to startup generic services.

    Connects to statsd, and calls AsyncStatsClient.create_socket @@ -452,7 +456,7 @@ and

    -async wait_until_guild_available()[source]#
    +async wait_until_guild_available()[source]#

    Wait until the guild that matches the guild_id given at init is available (and the cache is ready).

    The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE gateway event before giving up and thus not populating the cache for unavailable guilds.

    @@ -467,12 +471,12 @@ gateway event before giving up and thus not populating the cache for unavailable
    -exception StartupError(base)[source]#
    +exception StartupError(base)[source]#

    Bases: Exception

    Exception class for startup errors.

    -__init__(base)[source]#
    +__init__(base)[source]#
    diff --git a/v7.2.0/output/botcore.site_api.html b/v7.2.0/output/botcore.site_api.html index 235b1b19..c6fc0e14 100644 --- a/v7.2.0/output/botcore.site_api.html +++ b/v7.2.0/output/botcore.site_api.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/output/botcore.utils.caching.html b/v7.2.0/output/botcore.utils.caching.html index 00078021..90fe6358 100644 --- a/v7.2.0/output/botcore.utils.caching.html +++ b/v7.2.0/output/botcore.utils.caching.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/output/botcore.utils.channel.html b/v7.2.0/output/botcore.utils.channel.html index 43bd879b..13b211ac 100644 --- a/v7.2.0/output/botcore.utils.channel.html +++ b/v7.2.0/output/botcore.utils.channel.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/output/botcore.utils.html b/v7.2.0/output/botcore.utils.html index 70ca43d0..123ce7c5 100644 --- a/v7.2.0/output/botcore.utils.html +++ b/v7.2.0/output/botcore.utils.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • @@ -318,7 +322,7 @@ that will act as top-level groups rather than being aliases of the command’s g
    -unqualify(name)[source]#
    +unqualify(name)[source]#

    Return an unqualified name given a qualified module/package name.

    Parameters:
    diff --git a/v7.2.0/output/botcore.utils.logging.html b/v7.2.0/output/botcore.utils.logging.html index da07fb78..27e988ce 100644 --- a/v7.2.0/output/botcore.utils.logging.html +++ b/v7.2.0/output/botcore.utils.logging.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/output/botcore.utils.members.html b/v7.2.0/output/botcore.utils.members.html index d1d386d0..c7e4ffc3 100644 --- a/v7.2.0/output/botcore.utils.members.html +++ b/v7.2.0/output/botcore.utils.members.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/output/botcore.utils.regex.html b/v7.2.0/output/botcore.utils.regex.html index 5a9c6254..5c46513a 100644 --- a/v7.2.0/output/botcore.utils.regex.html +++ b/v7.2.0/output/botcore.utils.regex.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/output/botcore.utils.scheduling.html b/v7.2.0/output/botcore.utils.scheduling.html index f90c5f81..0df8f88d 100644 --- a/v7.2.0/output/botcore.utils.scheduling.html +++ b/v7.2.0/output/botcore.utils.scheduling.html @@ -208,6 +208,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/py-modindex.html b/v7.2.0/py-modindex.html index 593a7601..d465772f 100644 --- a/v7.2.0/py-modindex.html +++ b/v7.2.0/py-modindex.html @@ -206,6 +206,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/search.html b/v7.2.0/search.html index bfdd7a2f..1182fed4 100644 --- a/v7.2.0/search.html +++ b/v7.2.0/search.html @@ -205,6 +205,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • diff --git a/v7.2.0/versions.html b/v7.2.0/versions.html index 3a0741f8..0597416d 100644 --- a/v7.2.0/versions.html +++ b/v7.2.0/versions.html @@ -207,6 +207,10 @@ v7.4.0-beta1 +
  • + v7.4.0 +
    • +
  • v7.3.1
    • @@ -310,6 +314,12 @@ v7.4.0-beta1 + + +
  • + v7.4.0 + +
  • -- cgit v1.2.3