From 62643d2772008eb2161e5a455d0067efe847585b Mon Sep 17 00:00:00 2001 From: wookie184 Date: Thu, 18 Jul 2024 19:25:28 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20docs=20from=20@=20python-disco?= =?UTF-8?q?rd/bot-core@d04b2d507f5799680d7da50424e38e567cfdd7cf=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/.buildinfo | 2 +- main/output/pydis_core.async_stats.html | 6 +- main/output/pydis_core.html | 62 +++++++++---------- main/output/pydis_core.site_api.html | 26 ++++---- main/output/pydis_core.utils.caching.html | 8 +-- main/output/pydis_core.utils.channel.html | 4 +- main/output/pydis_core.utils.checks.html | 14 ++--- main/output/pydis_core.utils.commands.html | 2 +- main/output/pydis_core.utils.cooldown.html | 12 ++-- ...ore.utils.error_handling.commands.abc.html | 8 +-- ...is_core.utils.error_handling.commands.html | 16 ++--- ...utils.error_handling.commands.manager.html | 8 +-- .../pydis_core.utils.error_handling.html | 2 +- main/output/pydis_core.utils.function.html | 12 ++-- main/output/pydis_core.utils.html | 4 +- .../output/pydis_core.utils.interactions.html | 18 +++--- main/output/pydis_core.utils.lock.html | 22 +++---- main/output/pydis_core.utils.logging.html | 8 +-- main/output/pydis_core.utils.members.html | 4 +- main/output/pydis_core.utils.messages.html | 2 +- main/output/pydis_core.utils.pagination.html | 12 ++-- .../pydis_core.utils.paste_service.html | 14 ++--- main/output/pydis_core.utils.regex.html | 6 +- main/output/pydis_core.utils.scheduling.html | 18 +++--- v10.0.0/.buildinfo | 2 +- v10.1.0/.buildinfo | 2 +- v10.2.0/.buildinfo | 2 +- v10.3.0/.buildinfo | 2 +- v10.4.0/.buildinfo | 2 +- v10.5.0/.buildinfo | 2 +- v10.5.1/.buildinfo | 2 +- v10.6.0/.buildinfo | 2 +- v10.7.0/.buildinfo | 2 +- v11.0.0/.buildinfo | 2 +- v11.0.1/.buildinfo | 2 +- v11.1.0/.buildinfo | 2 +- v11.2.0/.buildinfo | 2 +- v11.3.0/.buildinfo | 2 +- v9.0.0/.buildinfo | 2 +- v9.1.1/.buildinfo | 2 +- v9.10.0-alpha.1/.buildinfo | 2 +- v9.10.0-alpha.2/.buildinfo | 2 +- v9.2.0/.buildinfo | 2 +- v9.3.0/.buildinfo | 2 +- v9.4.0/.buildinfo | 2 +- v9.4.1/.buildinfo | 2 +- v9.5.0/.buildinfo | 2 +- v9.5.1/.buildinfo | 2 +- v9.6.0/.buildinfo | 2 +- v9.7.0/.buildinfo | 2 +- v9.8.0/.buildinfo | 2 +- v9.9.0/.buildinfo | 2 +- v9.9.1/.buildinfo | 2 +- v9.9.2/.buildinfo | 2 +- 54 files changed, 175 insertions(+), 175 deletions(-) diff --git a/main/.buildinfo b/main/.buildinfo index 7178cd3a8..ab6c66a26 100644 --- a/main/.buildinfo +++ b/main/.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: 2cf4ecb127505c7bcbeecfccb71fba99 +config: b21ebf78b953aa0c5a18cf71e1e7ef3a tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/output/pydis_core.async_stats.html b/main/output/pydis_core.async_stats.html index 5eae526e9..bf582ec66 100644 --- a/main/output/pydis_core.async_stats.html +++ b/main/output/pydis_core.async_stats.html @@ -465,12 +465,12 @@

An async transport method for statsd communication.

-class AsyncStatsClient(loop, host='localhost', port=8125, prefix=None)[source]
+class AsyncStatsClient(loop, host='localhost', port=8125, prefix=None)[source]

Bases: StatsClientBase

An async implementation of statsd.client.base.StatsClientBase that supports async stat communication.

-__init__(loop, host='localhost', port=8125, prefix=None)[source]
+__init__(loop, host='localhost', port=8125, prefix=None)[source]

Create a new AsyncStatsClient.

Parameters:
@@ -487,7 +487,7 @@
-async create_socket()[source]
+async create_socket()[source]

Use asyncio.loop.create_datagram_endpoint from the loop given on init to create a socket.

Return type:
diff --git a/main/output/pydis_core.html b/main/output/pydis_core.html index c8e370f83..58619cd60 100644 --- a/main/output/pydis_core.html +++ b/main/output/pydis_core.html @@ -465,12 +465,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.

-guild_id[source]
+guild_id[source]

ID of the guild that the bot belongs to.

Type:
@@ -481,7 +481,7 @@
-http_session[source]
+http_session[source]

The http session used for sending out HTTP requests.

Type:
@@ -492,7 +492,7 @@
-api_client[source]
+api_client[source]

The API client used for communications with the site service.

Type:
@@ -503,7 +503,7 @@
-statsd_url[source]
+statsd_url[source]

The url that statsd sends metrics to.

Type:
@@ -514,7 +514,7 @@
-redis_session[source]
+redis_session[source]

The redis session used to communicate with the Redis instance.

Type:
@@ -525,7 +525,7 @@
-stats[source]
+stats[source]

The statsd client that sends metrics.

Type:
@@ -536,7 +536,7 @@
-all_extensions[source]
+all_extensions[source]

All extensions that were found within the module passed to self.load_extensions. Use self.extensions to get the loaded extensions.

@@ -548,7 +548,7 @@
-__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:
@@ -567,7 +567,7 @@
-async add_cog(cog)[source]
+async add_cog(cog)[source]

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

Return type:
@@ -578,7 +578,7 @@
-add_command(command)[source]
+add_command(command)[source]

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

Return type:
@@ -589,7 +589,7 @@
-clear()[source]
+clear()[source]

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

Return type:
@@ -600,7 +600,7 @@
-async close()[source]
+async close()[source]

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

Return type:
@@ -611,7 +611,7 @@
-async load_extensions(module, *, sync_app_commands=True)[source]
+async load_extensions(module, *, sync_app_commands=True)[source]

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

Parameters:
@@ -625,7 +625,7 @@
-async log_to_dev_log(message)[source]
+async log_to_dev_log(message)[source]

Log the given message to #dev-log.

Return type:
@@ -636,7 +636,7 @@
-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.

@@ -649,7 +649,7 @@
-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:
@@ -660,7 +660,7 @@
-async ping_services()[source]
+async ping_services()[source]

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

Return type:
@@ -671,7 +671,7 @@
-async process_commands(message)[source]
+async process_commands(message)[source]

Overwrite default Discord.py behaviour to process commands only after ensuring extensions are loaded.

This extension check is only relevant for clients that make use of pydis_core.BotBase.load_extensions.

@@ -683,7 +683,7 @@
-register_command_error_manager(manager)[source]
+register_command_error_manager(manager)[source]

Bind an instance of the command error manager to both the bot and the command tree.

The reason this doesn’t happen in the constructor is because error handlers might need an instance of the bot. So registration needs to happen once the bot instance has been created.

@@ -696,7 +696,7 @@
-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.

@@ -709,7 +709,7 @@
-async setup_hook()[source]
+async setup_hook()[source]

An async init to startup generic services.

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

-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.

@@ -738,14 +738,14 @@
-exception EmptyPaginatorEmbedError[source]
+exception EmptyPaginatorEmbedError[source]

Bases: Exception

Raised when attempting to paginate with empty contents.

-class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]
+class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]

Bases: Paginator

A class that aids in paginating code blocks for Discord messages.

@@ -762,14 +762,14 @@
-__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]
+__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]

This function overrides the Paginator.__init__ from inside discord.ext.commands.

It overrides in order to allow us to configure the maximum number of lines per page.

-add_line(line='', *, empty=False)[source]
+add_line(line='', *, empty=False)[source]

Adds a line to the current page.

If a line on a page exceeds max_size characters, then max_size will go up to scale_to_size for a single line before creating a new page for the overflow words. If it @@ -797,7 +797,7 @@

-async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]
+async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]

Use a paginator and set of reactions to provide pagination over a set of lines.

The reactions are used to switch page, or to finish with pagination.

When used, this will send a message using ctx.send() and apply a set of reactions to it. These reactions may @@ -841,7 +841,7 @@

-class PaginationEmojis(**data)[source]
+class PaginationEmojis(**data)[source]

Bases: BaseModel

The emojis that will be used for pagination.

@@ -868,12 +868,12 @@
-exception StartupError(base)[source]
+exception StartupError(base)[source]

Bases: Exception

Exception class for startup errors.

-__init__(base)[source]
+__init__(base)[source]
diff --git a/main/output/pydis_core.site_api.html b/main/output/pydis_core.site_api.html index db4759216..1866fb6d3 100644 --- a/main/output/pydis_core.site_api.html +++ b/main/output/pydis_core.site_api.html @@ -465,12 +465,12 @@

An API wrapper around the Site API.

-class APIClient(site_api_url, site_api_token, **session_kwargs)[source]
+class APIClient(site_api_url, site_api_token, **session_kwargs)[source]

Bases: object

A wrapper for the Django Site API.

-__init__(site_api_url, site_api_token, **session_kwargs)[source]
+__init__(site_api_url, site_api_token, **session_kwargs)[source]

Initialize a new APIClient instance.

Parameters:
@@ -485,7 +485,7 @@
-async close()[source]
+async close()[source]

Close the aiohttp session.

Return type:
@@ -496,7 +496,7 @@
-async delete(endpoint, *, raise_for_status=True, **kwargs)[source]
+async delete(endpoint, *, raise_for_status=True, **kwargs)[source]

Equivalent to APIClient.request() with DELETE passed as the method.

Return type:
@@ -507,7 +507,7 @@
-async get(endpoint, *, raise_for_status=True, **kwargs)[source]
+async get(endpoint, *, raise_for_status=True, **kwargs)[source]

Equivalent to APIClient.request() with GET passed as the method.

Return type:
@@ -518,7 +518,7 @@
-async static maybe_raise_for_status(response, *, should_raise)[source]
+async static maybe_raise_for_status(response, *, should_raise)[source]

Raise ResponseCodeError for non-OK response if an exception should be raised.

Parameters:
@@ -538,7 +538,7 @@
-async patch(endpoint, *, raise_for_status=True, **kwargs)[source]
+async patch(endpoint, *, raise_for_status=True, **kwargs)[source]

Equivalent to APIClient.request() with PATCH passed as the method.

Return type:
@@ -549,7 +549,7 @@
-async post(endpoint, *, raise_for_status=True, **kwargs)[source]
+async post(endpoint, *, raise_for_status=True, **kwargs)[source]

Equivalent to APIClient.request() with POST passed as the method.

Return type:
@@ -560,7 +560,7 @@
-async put(endpoint, *, raise_for_status=True, **kwargs)[source]
+async put(endpoint, *, raise_for_status=True, **kwargs)[source]

Equivalent to APIClient.request() with PUT passed as the method.

Return type:
@@ -571,7 +571,7 @@
-async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]
+async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]

Send an HTTP request to the site API and return the JSON response.

Parameters:
@@ -598,12 +598,12 @@
-exception ResponseCodeError(response, response_json=None, response_text=None)[source]
+exception ResponseCodeError(response, response_json=None, response_text=None)[source]

Bases: ValueError

Raised in APIClient.request() when a non-OK HTTP response is received.

-__init__(response, response_json=None, response_text=None)[source]
+__init__(response, response_json=None, response_text=None)[source]

Initialize a new ResponseCodeError instance.

Parameters:
@@ -618,7 +618,7 @@
-__str__()[source]
+__str__()[source]

Return a string representation of the error.

diff --git a/main/output/pydis_core.utils.caching.html b/main/output/pydis_core.utils.caching.html index 6d19f5db4..980cb422b 100644 --- a/main/output/pydis_core.utils.caching.html +++ b/main/output/pydis_core.utils.caching.html @@ -465,14 +465,14 @@

Utilities related to custom caches.

-class AsyncCache(max_size=128)[source]
+class AsyncCache(max_size=128)[source]

Bases: object

LRU cache implementation for coroutines.

Once the cache exceeds the maximum size, keys are deleted in FIFO order.

An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.

-__call__(arg_offset=0)[source]
+__call__(arg_offset=0)[source]

Decorator for async cache.

Parameters:
@@ -489,7 +489,7 @@
-__init__(max_size=128)[source]
+__init__(max_size=128)[source]

Initialise a new AsyncCache instance.

Parameters:
@@ -500,7 +500,7 @@
-clear()[source]
+clear()[source]

Clear cache instance.

Return type:
diff --git a/main/output/pydis_core.utils.channel.html b/main/output/pydis_core.utils.channel.html index 405828792..173f5f742 100644 --- a/main/output/pydis_core.utils.channel.html +++ b/main/output/pydis_core.utils.channel.html @@ -465,7 +465,7 @@

Useful helper functions for interacting with various discord channel objects.

-async get_or_fetch_channel(bot, channel_id)[source]
+async get_or_fetch_channel(bot, channel_id)[source]

Attempt to get or fetch the given channel_id from the bots cache, and return it.

Parameters:
@@ -493,7 +493,7 @@
-is_in_category(channel, category_id)[source]
+is_in_category(channel, category_id)[source]

Return whether the given channel in the the category with the id category_id.

Parameters:
diff --git a/main/output/pydis_core.utils.checks.html b/main/output/pydis_core.utils.checks.html index d2d8c137b..32e8a65e9 100644 --- a/main/output/pydis_core.utils.checks.html +++ b/main/output/pydis_core.utils.checks.html @@ -464,26 +464,26 @@

checks

-exception ContextCheckFailure(redirect_channel)[source]
+exception ContextCheckFailure(redirect_channel)[source]

Bases: CheckFailure

Raised when a context-specific check fails.

-__init__(redirect_channel)[source]
+__init__(redirect_channel)[source]
-exception InWhitelistCheckFailure(redirect_channel)[source]
+exception InWhitelistCheckFailure(redirect_channel)[source]

Bases: ContextCheckFailure

Raised when the in_whitelist check fails.

-cooldown_with_role_bypass(rate, per, type_=('default', 0), *, bypass_roles)[source]
+cooldown_with_role_bypass(rate, per, type_=('default', 0), *, bypass_roles)[source]

Decorate a command to have a cooldown, which can be bypassed by users with specified roles.

Note: This replaces the Command.before_invoke callback, which might introduce problems in the future.

@@ -509,7 +509,7 @@
-async has_any_role_check(ctx, *roles)[source]
+async has_any_role_check(ctx, *roles)[source]

Verify if the context’s author has any of the specified roles.

This check will always fail if the context is a DM, since DMs don’t have roles.

@@ -530,7 +530,7 @@
-async has_no_roles_check(ctx, *roles)[source]
+async has_no_roles_check(ctx, *roles)[source]

Verify if the context’s author doesn’t have any of the specified roles.

This check will always fail if the context is a DM, since DMs don’t have roles.

@@ -551,7 +551,7 @@
-in_whitelist_check(ctx, redirect, channels=(), categories=(), roles=(), *, fail_silently=False)[source]
+in_whitelist_check(ctx, redirect, channels=(), categories=(), roles=(), *, fail_silently=False)[source]

Check if a command was issued in a context that is whitelisted by channel, category, or roles.

Parameters:
diff --git a/main/output/pydis_core.utils.commands.html b/main/output/pydis_core.utils.commands.html index 9a3a44af2..b5a3d208a 100644 --- a/main/output/pydis_core.utils.commands.html +++ b/main/output/pydis_core.utils.commands.html @@ -464,7 +464,7 @@

commands

-async clean_text_or_reply(ctx, text=None)[source]
+async clean_text_or_reply(ctx, text=None)[source]

Cleans a text argument or replied message’s content.

Parameters:
diff --git a/main/output/pydis_core.utils.cooldown.html b/main/output/pydis_core.utils.cooldown.html index 81ba6c8ae..2ce260fd2 100644 --- a/main/output/pydis_core.utils.cooldown.html +++ b/main/output/pydis_core.utils.cooldown.html @@ -465,17 +465,17 @@

Helpers for setting a cooldown on commands.

-exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]
+exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]

Bases: CommandError, Generic[P, R]

Raised when a command is invoked while on cooldown.

-__init__(message, function, /, *args, **kwargs)[source]
+__init__(message, function, /, *args, **kwargs)[source]
-async call_without_cooldown()[source]
+async call_without_cooldown()[source]

Run the command this cooldown blocked.

Return type:
@@ -491,20 +491,20 @@
-P = ~P[source]
+P = ~P[source]

The command’s signature.

-class R[source]
+class R[source]

The command’s return value.

alias of TypeVar(‘R’)

-block_duplicate_invocations(*, cooldown_duration=5, send_notice=False, args_preprocessor=None)[source]
+block_duplicate_invocations(*, cooldown_duration=5, send_notice=False, args_preprocessor=None)[source]

Prevent duplicate invocations of a command with the same arguments in a channel for cooldown_duration seconds.

Parameters:
diff --git a/main/output/pydis_core.utils.error_handling.commands.abc.html b/main/output/pydis_core.utils.error_handling.commands.abc.html index b927b4492..d66b9c844 100644 --- a/main/output/pydis_core.utils.error_handling.commands.abc.html +++ b/main/output/pydis_core.utils.error_handling.commands.abc.html @@ -464,12 +464,12 @@

abc

-class AbstractCommandErrorHandler[source]
+class AbstractCommandErrorHandler[source]

Bases: ABC

An abstract command error handler.

-abstract async handle_app_command_error(interaction, error)[source]
+abstract async handle_app_command_error(interaction, error)[source]

Handle error raised in the context of app commands.

Return type:
@@ -480,7 +480,7 @@
-abstract async handle_text_command_error(context, error)[source]
+abstract async handle_text_command_error(context, error)[source]

Handle error raised in the context of text commands.

Return type:
@@ -491,7 +491,7 @@
-abstract async should_handle_error(error)[source]
+abstract async should_handle_error(error)[source]

A predicate that determines whether the error should be handled.

Return type:
diff --git a/main/output/pydis_core.utils.error_handling.commands.html b/main/output/pydis_core.utils.error_handling.commands.html index 110e069cc..b439b0bf3 100644 --- a/main/output/pydis_core.utils.error_handling.commands.html +++ b/main/output/pydis_core.utils.error_handling.commands.html @@ -464,12 +464,12 @@

commands package

-class AbstractCommandErrorHandler[source]
+class AbstractCommandErrorHandler[source]

Bases: ABC

An abstract command error handler.

-abstract async handle_app_command_error(interaction, error)[source]
+abstract async handle_app_command_error(interaction, error)[source]

Handle error raised in the context of app commands.

Return type:
@@ -480,7 +480,7 @@
-abstract async handle_text_command_error(context, error)[source]
+abstract async handle_text_command_error(context, error)[source]

Handle error raised in the context of text commands.

Return type:
@@ -491,7 +491,7 @@
-abstract async should_handle_error(error)[source]
+abstract async should_handle_error(error)[source]

A predicate that determines whether the error should be handled.

Return type:
@@ -504,17 +504,17 @@
-class CommandErrorManager(default)[source]
+class CommandErrorManager(default)[source]

Bases: object

A class that registers error handlers and handles all command related errors.

-__init__(default)[source]
+__init__(default)[source]
-async handle_error(error, context_or_interaction)[source]
+async handle_error(error, context_or_interaction)[source]

Handle a Discord exception.

Iterate through available handlers by registration order, and choose the first one capable of handling the error as determined by should_handle_error; there is no priority system.

@@ -527,7 +527,7 @@
-register_handler(handler)[source]
+register_handler(handler)[source]

Register a command error handler.

Return type:
diff --git a/main/output/pydis_core.utils.error_handling.commands.manager.html b/main/output/pydis_core.utils.error_handling.commands.manager.html index a540aecce..e1d9d92ce 100644 --- a/main/output/pydis_core.utils.error_handling.commands.manager.html +++ b/main/output/pydis_core.utils.error_handling.commands.manager.html @@ -464,17 +464,17 @@

manager

-class CommandErrorManager(default)[source]
+class CommandErrorManager(default)[source]

Bases: object

A class that registers error handlers and handles all command related errors.

-__init__(default)[source]
+__init__(default)[source]
-async handle_error(error, context_or_interaction)[source]
+async handle_error(error, context_or_interaction)[source]

Handle a Discord exception.

Iterate through available handlers by registration order, and choose the first one capable of handling the error as determined by should_handle_error; there is no priority system.

@@ -487,7 +487,7 @@
-register_handler(handler)[source]
+register_handler(handler)[source]

Register a command error handler.

Return type:
diff --git a/main/output/pydis_core.utils.error_handling.html b/main/output/pydis_core.utils.error_handling.html index e76ad8626..78d79fd13 100644 --- a/main/output/pydis_core.utils.error_handling.html +++ b/main/output/pydis_core.utils.error_handling.html @@ -464,7 +464,7 @@

error_handling package

-async handle_forbidden_from_block(error, message=None)[source]
+async handle_forbidden_from_block(error, message=None)[source]

Handles discord.Forbidden 90001 errors, or re-raises if error isn’t a 90001 error.

Parameters:
diff --git a/main/output/pydis_core.utils.function.html b/main/output/pydis_core.utils.function.html index 21f2f66d2..39fee8776 100644 --- a/main/output/pydis_core.utils.function.html +++ b/main/output/pydis_core.utils.function.html @@ -465,14 +465,14 @@

Utils for manipulating functions.

-exception GlobalNameConflictError[source]
+exception GlobalNameConflictError[source]

Bases: Exception

Raised on a conflict between the globals used to resolve annotations of a wrapped function and its wrapper.

-command_wraps(wrapped, assigned=('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'), updated=('__dict__',), *, ignored_conflict_names=frozenset({}))[source]
+command_wraps(wrapped, assigned=('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'), updated=('__dict__',), *, ignored_conflict_names=frozenset({}))[source]

Update the decorated function to look like wrapped, and update globals for discord.py forwardref evaluation.

See update_wrapper_globals() for more details on how the globals are updated.

@@ -496,7 +496,7 @@
-get_arg_value(name_or_pos, arguments)[source]
+get_arg_value(name_or_pos, arguments)[source]

Return a value from arguments based on a name or position.

Parameters:
@@ -519,7 +519,7 @@
-get_arg_value_wrapper(decorator_func, name_or_pos, func=None)[source]
+get_arg_value_wrapper(decorator_func, name_or_pos, func=None)[source]

Call decorator_func with the value of the arg at the given name/position.

Parameters:
@@ -541,7 +541,7 @@
-get_bound_args(func, args, kwargs)[source]
+get_bound_args(func, args, kwargs)[source]

Bind args and kwargs to func and return a mapping of parameter names to argument values.

Default parameter values are also set.

@@ -563,7 +563,7 @@
-update_wrapper_globals(wrapper, wrapped, *, ignored_conflict_names=frozenset({}))[source]
+update_wrapper_globals(wrapper, wrapped, *, ignored_conflict_names=frozenset({}))[source]

Create a copy of wrapper, the copy’s globals are updated with wrapped's globals.

For forwardrefs in command annotations, discord.py uses the __global__ attribute of the function to resolve their values. This breaks for decorators that replace the function because they have diff --git a/main/output/pydis_core.utils.html b/main/output/pydis_core.utils.html index 1e58839c1..d66662df6 100644 --- a/main/output/pydis_core.utils.html +++ b/main/output/pydis_core.utils.html @@ -465,7 +465,7 @@

Useful utilities and tools for Discord bot development.

-apply_monkey_patches()[source]
+apply_monkey_patches()[source]

Applies all common monkey patches for our bots.

Return type:
@@ -484,7 +484,7 @@
-unqualify(name)[source]
+unqualify(name)[source]

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

Parameters:
diff --git a/main/output/pydis_core.utils.interactions.html b/main/output/pydis_core.utils.interactions.html index 1572cc0c8..05bc7268b 100644 --- a/main/output/pydis_core.utils.interactions.html +++ b/main/output/pydis_core.utils.interactions.html @@ -464,7 +464,7 @@

interactions

-class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]
+class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]

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.

@@ -479,12 +479,12 @@
-__init__(*, style=('secondary', 2), label='Delete', **kwargs)[source]
+__init__(*, style=('secondary', 2), label='Delete', **kwargs)[source]
-async callback(interaction)[source]
+async callback(interaction)[source]

Delete the original message on button click.

Return type:
@@ -497,7 +497,7 @@
-class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]
+class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]

Bases: View

A view that allows the original invoker and moderators to interact with it.

@@ -514,12 +514,12 @@
-__init__(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]
+__init__(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]
-async interaction_check(interaction)[source]
+async interaction_check(interaction)[source]

Ensure the user clicking the button is the view invoker, or a moderator.

Parameters:
@@ -533,7 +533,7 @@
-async on_timeout()[source]
+async on_timeout()[source]

Remove the view from self.message if set.

Return type:
@@ -544,7 +544,7 @@
-stop()[source]
+stop()[source]

Stop listening for interactions, and remove the view from self.message if set.

Return type:
@@ -557,7 +557,7 @@
-user_has_access(user, *, allowed_users=(), allowed_roles=())[source]
+user_has_access(user, *, allowed_users=(), allowed_roles=())[source]

Return whether the user is in the allowed_users list, or has a role from allowed_roles.

Parameters:
diff --git a/main/output/pydis_core.utils.lock.html b/main/output/pydis_core.utils.lock.html index 3af68b306..8f90ddcae 100644 --- a/main/output/pydis_core.utils.lock.html +++ b/main/output/pydis_core.utils.lock.html @@ -464,12 +464,12 @@

lock

-exception LockedResourceError(resource_type, resource_id)[source]
+exception LockedResourceError(resource_type, resource_id)[source]

Bases: RuntimeError

Exception raised when an operation is attempted on a locked resource.

-type[source]
+type[source]

Name of the locked resource’s type

Type:
@@ -480,7 +480,7 @@
-id[source]
+id[source]

ID of the locked resource

Type:
@@ -491,38 +491,38 @@
-__init__(resource_type, resource_id)[source]
+__init__(resource_type, resource_id)[source]
-class SharedEvent[source]
+class SharedEvent[source]

Bases: object

Context manager managing an internal event exposed through the wait coro.

While any code is executing in this context manager, the underlying event will not be set; when all of the holders finish the event will be set.

-__enter__()[source]
+__enter__()[source]

Increment the count of the active holders and clear the internal event.

-__exit__(_exc_type, _exc_val, _exc_tb)[source]
+__exit__(_exc_type, _exc_val, _exc_tb)[source]

Decrement the count of the active holders; if 0 is reached set the internal event.

-__init__()[source]
+__init__()[source]
-async wait()[source]
+async wait()[source]

Wait for all active holders to exit.

Return type:
@@ -535,7 +535,7 @@
-lock(namespace, resource_id, *, raise_error=False, wait=False)[source]
+lock(namespace, resource_id, *, raise_error=False, wait=False)[source]

Turn the decorated coroutine function into a mutually exclusive operation on a resource_id.

If decorating a command, this decorator must go before (below) the command decorator.

@@ -562,7 +562,7 @@
-lock_arg(namespace, name_or_pos, func=None, *, raise_error=False, wait=False)[source]
+lock_arg(namespace, name_or_pos, func=None, *, raise_error=False, wait=False)[source]

Apply the lock decorator using the value of the arg at the given name/position as the ID.

See lock docs for more information.

diff --git a/main/output/pydis_core.utils.logging.html b/main/output/pydis_core.utils.logging.html index 3c37d31c5..8e077ae84 100644 --- a/main/output/pydis_core.utils.logging.html +++ b/main/output/pydis_core.utils.logging.html @@ -465,12 +465,12 @@

Common logging related functions.

-class CustomLogger(name, level=0)[source]
+class CustomLogger(name, level=0)[source]

Bases: Logger

Custom implementation of the logging.Logger class with an added trace method.

-trace(msg, *args, **kwargs)[source]
+trace(msg, *args, **kwargs)[source]

Log the given message with the severity "TRACE".

To pass exception information, use the keyword argument exc_info with a true value:

logger.trace("Houston, we have an %s", "interesting problem", exc_info=1)
@@ -494,7 +494,7 @@
 
 

 

-get_logger(name=None)[source]

+get_logger(name=None)[source]
 
Utility to make mypy recognise that logger is of type CustomLogger.

 

 
Parameters:

@@ -511,7 +511,7 @@
 
 

 

-log_format[source]

+log_format[source]
 
A logging.Formatter that can be used to standardise logging across all projects using pydis_core.

 

 

diff --git a/main/output/pydis_core.utils.members.html b/main/output/pydis_core.utils.members.html
index 79be5a015..2d3bd2fd5 100644
--- a/main/output/pydis_core.utils.members.html
+++ b/main/output/pydis_core.utils.members.html
@@ -465,7 +465,7 @@
 
Useful helper functions for interactin with discord.Member objects.

 

 

-async get_or_fetch_member(guild, member_id)[source]

+async get_or_fetch_member(guild, member_id)[source]
 
Attempt to get a member from cache; on failure fetch from the API.

 

 
Return type:

@@ -479,7 +479,7 @@
 
 

 

-async handle_role_change(member, coro, role)[source]

+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.

diff --git a/main/output/pydis_core.utils.messages.html b/main/output/pydis_core.utils.messages.html
index 3daf12b6a..177f14d4f 100644
--- a/main/output/pydis_core.utils.messages.html
+++ b/main/output/pydis_core.utils.messages.html
@@ -464,7 +464,7 @@
 
messages

 

 

-reaction_check(reaction, user, *, message_id, allowed_emoji, allowed_users, allowed_roles=None)[source]

+reaction_check(reaction, user, *, message_id, allowed_emoji, allowed_users, allowed_roles=None)[source]
 
Check if a reaction’s emoji and author are allowed and the message is message_id.

 
If the user is not allowed, remove the reaction. Ignore reactions made by the bot.
 If allow_mods is True, allow users with moderator roles even if they’re not in allowed_users.

diff --git a/main/output/pydis_core.utils.pagination.html b/main/output/pydis_core.utils.pagination.html
index d5617a877..be56e5d3e 100644
--- a/main/output/pydis_core.utils.pagination.html
+++ b/main/output/pydis_core.utils.pagination.html
@@ -464,14 +464,14 @@
 
pagination

 

 

-exception EmptyPaginatorEmbedError[source]

+exception EmptyPaginatorEmbedError[source]
 
Bases: Exception

 
Raised when attempting to paginate with empty contents.

 

 
 

 

-class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]

+class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]
 
Bases: Paginator

 
A class that aids in paginating code blocks for Discord messages.

 

@@ -488,14 +488,14 @@
 

 

 

-__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]

+__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]
 
This function overrides the Paginator.__init__ from inside discord.ext.commands.

 
It overrides in order to allow us to configure the maximum number of lines per page.

 

 
 

 

-add_line(line='', *, empty=False)[source]

+add_line(line='', *, empty=False)[source]
 
Adds a line to the current page.

 
If a line on a page exceeds max_size characters, then max_size will go up to
 scale_to_size for a single line before creating a new page for the overflow words. If it
@@ -523,7 +523,7 @@
 
 

 

-async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]

+async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]
 
Use a paginator and set of reactions to provide pagination over a set of lines.

 
The reactions are used to switch page, or to finish with pagination.

 
When used, this will send a message using ctx.send() and apply a set of reactions to it. These reactions may
@@ -567,7 +567,7 @@
 
 

 

-class PaginationEmojis(**data)[source]

+class PaginationEmojis(**data)[source]
 
Bases: BaseModel

 
The emojis that will be used for pagination.

 

diff --git a/main/output/pydis_core.utils.paste_service.html b/main/output/pydis_core.utils.paste_service.html
index 3d8145051..c9fa6afab 100644
--- a/main/output/pydis_core.utils.paste_service.html
+++ b/main/output/pydis_core.utils.paste_service.html
@@ -464,13 +464,13 @@
 
paste_service

 

 

-MAX_PASTE_SIZE = 524288[source]

+MAX_PASTE_SIZE = 524288[source]
 
The maximum allows size of a paste, in bytes.

 

 
 

 

-class PasteFile(**data)[source]

+class PasteFile(**data)[source]
 
Bases: BaseModel

 
A file to be pasted to the paste service.

 

@@ -506,7 +506,7 @@
 
 

 

-class PasteResponse(**data)[source]

+class PasteResponse(**data)[source]
 
Bases: BaseModel

 
A successful response from the paste service.

 

@@ -541,28 +541,28 @@
 
 

 

-exception PasteTooLongError[source]

+exception PasteTooLongError[source]
 
Bases: Exception

 
Raised when content is too large to upload to the paste service.

 

 
 

 

-exception PasteUnsupportedLexerError[source]

+exception PasteUnsupportedLexerError[source]
 
Bases: Exception

 
Raised when an unsupported lexer is used.

 

 
 

 

-exception PasteUploadError[source]

+exception PasteUploadError[source]
 
Bases: Exception

 
Raised when an error is encountered uploading to the paste service.

 

 
 

 

-async send_to_paste_service(*, files, http_session, paste_url='https://paste.pythondiscord.com', max_size=524288)[source]

+async send_to_paste_service(*, files, http_session, paste_url='https://paste.pythondiscord.com', max_size=524288)[source]
 
Upload some contents to the paste service.

 

 
Parameters:

diff --git a/main/output/pydis_core.utils.regex.html b/main/output/pydis_core.utils.regex.html
index ab0cadd0e..88f43e3a3 100644
--- a/main/output/pydis_core.utils.regex.html
+++ b/main/output/pydis_core.utils.regex.html
@@ -465,7 +465,7 @@
 
Common regular expressions.

 

 

-DISCORD_INVITE[source]

+DISCORD_INVITE[source]
 
Regex for Discord server invites.

 

 
Warning

@@ -479,7 +479,7 @@
 
 

 

-FORMATTED_CODE_REGEX[source]

+FORMATTED_CODE_REGEX[source]
 
Regex for formatted code, using Discord’s code blocks.

 

 

@@ -487,7 +487,7 @@
 
 

 

-RAW_CODE_REGEX[source]

+RAW_CODE_REGEX[source]
 
Regex for raw code, not using Discord’s code blocks.

 

 

diff --git a/main/output/pydis_core.utils.scheduling.html b/main/output/pydis_core.utils.scheduling.html
index b79cf9814..8753ce8c5 100644
--- a/main/output/pydis_core.utils.scheduling.html
+++ b/main/output/pydis_core.utils.scheduling.html
@@ -465,7 +465,7 @@
 
Generic python scheduler.

 

 

-class Scheduler(name)[source]

+class Scheduler(name)[source]
 
Bases: object

 
Schedule the execution of coroutines and keep track of them.

 
When instantiating a Scheduler, a name must be provided. This name is used to distinguish the
@@ -479,7 +479,7 @@
 
Any exception raised in a scheduled task is logged when the task is done.

 

 

-__contains__(task_id)[source]

+__contains__(task_id)[source]
 
Return True if a task with the given task_id is currently scheduled.

 

 
Parameters:

@@ -496,7 +496,7 @@
 
 

 

-__init__(name)[source]

+__init__(name)[source]
 
Initialize a new Scheduler instance.

 

 
Parameters:

@@ -507,7 +507,7 @@
 
 

 

-cancel(task_id)[source]

+cancel(task_id)[source]
 
Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

 

 
Parameters:

@@ -521,7 +521,7 @@
 
 

 

-cancel_all()[source]

+cancel_all()[source]
 
Unschedule all known tasks.

 

 
Return type:

@@ -532,7 +532,7 @@
 
 

 

-schedule(task_id, coroutine)[source]

+schedule(task_id, coroutine)[source]
 
Schedule the execution of a coroutine.

 
If a task with task_id already exists, close coroutine instead of scheduling it. This
 prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

@@ -551,7 +551,7 @@
 
 

 

-schedule_at(time, task_id, coroutine)[source]

+schedule_at(time, task_id, coroutine)[source]
 
Schedule coroutine to be executed at the given time.

 
If time is timezone aware, then use that timezone to calculate now() when subtracting.
 If time is naïve, then use UTC.

@@ -574,7 +574,7 @@
 
 

 

-schedule_later(delay, task_id, coroutine)[source]

+schedule_later(delay, task_id, coroutine)[source]
 
Schedule coroutine to be executed after delay seconds.

 
If a task with task_id already exists, close coroutine instead of scheduling it. This
 prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

@@ -596,7 +596,7 @@
 
 

 

-create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]

+create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]
 
Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

 
If the event_loop kwarg is provided, the task is created from that event loop,
 otherwise the running loop is used.

diff --git a/v10.0.0/.buildinfo b/v10.0.0/.buildinfo
index 8b0525f86..b5b70f1a5 100644
--- a/v10.0.0/.buildinfo
+++ b/v10.0.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: 5a108bb3e3d93946b5997bf3ce7573c1
+config: 3283c2e33a9b26b15e1496d0f104f333
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v10.1.0/.buildinfo b/v10.1.0/.buildinfo
index 012a63749..57b6f6838 100644
--- a/v10.1.0/.buildinfo
+++ b/v10.1.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: 4b0a3c7aeda2f0a3e99f8625f8836213
+config: faef1433bcbc4b0ee19a0c66f821ae74
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v10.2.0/.buildinfo b/v10.2.0/.buildinfo
index 7132a4afb..b448a1941 100644
--- a/v10.2.0/.buildinfo
+++ b/v10.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: f62be1c1bf6042c6ed9a8ad5b12970cd
+config: 5d0cd99b9ebcc6f45bedacb4734714f1
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v10.3.0/.buildinfo b/v10.3.0/.buildinfo
index cde48822d..0b65393ac 100644
--- a/v10.3.0/.buildinfo
+++ b/v10.3.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: b6e6a4b0b7af3f4be2d729f41eca71ac
+config: 1927a74857cd855c111bdff4134ab5e4
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v10.4.0/.buildinfo b/v10.4.0/.buildinfo
index 416c2fb96..6cc77b236 100644
--- a/v10.4.0/.buildinfo
+++ b/v10.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: 8b136e7c8b3345b604fb80f119ace07f
+config: 5141d6e246a579888f60e08890209272
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v10.5.0/.buildinfo b/v10.5.0/.buildinfo
index 868d09200..f12fb090e 100644
--- a/v10.5.0/.buildinfo
+++ b/v10.5.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: fc55a2cca1f4f1806de36a202a24d395
+config: 99bc2a7bc41ee0c922856007e6b85c5d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v10.5.1/.buildinfo b/v10.5.1/.buildinfo
index 848a43884..53f2a1a15 100644
--- a/v10.5.1/.buildinfo
+++ b/v10.5.1/.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: 2685de64fa28ac1bacf7d0af839e988a
+config: 45838034739e247541d49fbdb11314c8
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v10.6.0/.buildinfo b/v10.6.0/.buildinfo
index 39c435ec4..b3b78df57 100644
--- a/v10.6.0/.buildinfo
+++ b/v10.6.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: 9a1e0981d25696c439dad1fa2010824f
+config: 18bc5ac6472199931a48335d5a72120d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v10.7.0/.buildinfo b/v10.7.0/.buildinfo
index d4da0bfc1..afa3a34e7 100644
--- a/v10.7.0/.buildinfo
+++ b/v10.7.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: 257c6fdbf6d384b1857237d93e1756a2
+config: 9561ccacb40035e6fb81d6b026495cd2
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v11.0.0/.buildinfo b/v11.0.0/.buildinfo
index 5af3cd97e..6f7d7c8a2 100644
--- a/v11.0.0/.buildinfo
+++ b/v11.0.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: 1faf77263b84b2776f9f780cab1ac13d
+config: a6336315c73b03e45998b264b6794b38
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v11.0.1/.buildinfo b/v11.0.1/.buildinfo
index 86d42b5f9..c8a510c46 100644
--- a/v11.0.1/.buildinfo
+++ b/v11.0.1/.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: 192181a04907fe6f16022835595e6cda
+config: 8404bbf28a647c324571591ff289b819
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v11.1.0/.buildinfo b/v11.1.0/.buildinfo
index a7d6889e2..0af39cb75 100644
--- a/v11.1.0/.buildinfo
+++ b/v11.1.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: 6f0d2a7c7ecce89629a6460b7bddd30c
+config: 03721d4b28b852470995398c6eef876f
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v11.2.0/.buildinfo b/v11.2.0/.buildinfo
index 4a1858a32..78eeafa48 100644
--- a/v11.2.0/.buildinfo
+++ b/v11.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: 8848db734be380a918953e361a4c6847
+config: fb6c73f67a68bd095959a6adfdc68337
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v11.3.0/.buildinfo b/v11.3.0/.buildinfo
index e914f88ca..860330f95 100644
--- a/v11.3.0/.buildinfo
+++ b/v11.3.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: 3524da2ff5fbb55228393e0add5ebada
+config: f360b9bafda41328342c832ed8e3504e
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.0.0/.buildinfo b/v9.0.0/.buildinfo
index 0b5e19042..f17404f2d 100644
--- a/v9.0.0/.buildinfo
+++ b/v9.0.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: 99057272274bf6b75ad164709a9a6632
+config: adeedfd2d73e63817338ff42a3b62107
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.1.1/.buildinfo b/v9.1.1/.buildinfo
index 7f2dd9020..d62b6e700 100644
--- a/v9.1.1/.buildinfo
+++ b/v9.1.1/.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: 4ab83f7b91834374fbb9a95af09db977
+config: f9df8575a6150cf6352dc239ce279b7d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.10.0-alpha.1/.buildinfo b/v9.10.0-alpha.1/.buildinfo
index 79596e09d..45a292960 100644
--- a/v9.10.0-alpha.1/.buildinfo
+++ b/v9.10.0-alpha.1/.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: 5b1e5c55e7c5c0b47e2f136109a38c68
+config: a1319cf2ab3477dcc43c59dafbdba915
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.10.0-alpha.2/.buildinfo b/v9.10.0-alpha.2/.buildinfo
index fc82eaf0b..3223dcca7 100644
--- a/v9.10.0-alpha.2/.buildinfo
+++ b/v9.10.0-alpha.2/.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: 0556ddfe80cffaf3eff3e1218acbaa60
+config: bd14f7ec1f8fafd1cc17d8580b3c74c4
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.2.0/.buildinfo b/v9.2.0/.buildinfo
index 96354804c..a92868cf9 100644
--- a/v9.2.0/.buildinfo
+++ b/v9.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: 9ec116f3c0e9f54b7d42f7d4b474ac23
+config: 6449cd8d384857954e85a4a963663a77
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.3.0/.buildinfo b/v9.3.0/.buildinfo
index 9e43916b1..f316e4d0c 100644
--- a/v9.3.0/.buildinfo
+++ b/v9.3.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: f7d1b2a759d78671a73036d04fd5f528
+config: 40acf93f8f9b8be809c6480ab493835c
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.4.0/.buildinfo b/v9.4.0/.buildinfo
index 09313fe04..00c49188f 100644
--- a/v9.4.0/.buildinfo
+++ b/v9.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: 23313e22a4b62d89e632b1ceace81bea
+config: 24c26d36c09ee6a17d475246be744610
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.4.1/.buildinfo b/v9.4.1/.buildinfo
index 44c791a7f..c7f681fd3 100644
--- a/v9.4.1/.buildinfo
+++ b/v9.4.1/.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: 165e2c96d71bcc39585d71026deadaa0
+config: 57ccb1a6d14c547a4c035439c18b931d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.5.0/.buildinfo b/v9.5.0/.buildinfo
index 1475e291d..482b4b362 100644
--- a/v9.5.0/.buildinfo
+++ b/v9.5.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: 14c15a55a275750c1ea7b0d0135e3f97
+config: 218d1c98f02e0dfd47555d44c99fcc65
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.5.1/.buildinfo b/v9.5.1/.buildinfo
index 22cfb38c3..83a93d91b 100644
--- a/v9.5.1/.buildinfo
+++ b/v9.5.1/.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: 6e51dbe9a274f987cf2de8cda0c5db69
+config: b014ce0ee5ca5a8631bd36d35c42e341
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.6.0/.buildinfo b/v9.6.0/.buildinfo
index e789fa49e..52067978a 100644
--- a/v9.6.0/.buildinfo
+++ b/v9.6.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: 88071d4748203c3304c7a2d84d23bede
+config: 4c951dad3cc84f2d7c8469ffd56aa32d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.7.0/.buildinfo b/v9.7.0/.buildinfo
index c248aded4..465d94572 100644
--- a/v9.7.0/.buildinfo
+++ b/v9.7.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: 3cebdced3457864f9ad7fe11e6a972dc
+config: 3c8e8ed1f1e220c6aff94045c55a8f5a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.8.0/.buildinfo b/v9.8.0/.buildinfo
index 86abf1c0f..da501e180 100644
--- a/v9.8.0/.buildinfo
+++ b/v9.8.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: b5b4be626c5d38d441f76751fcad0b27
+config: 4cfd712a6a4ac5ab7467b10336c75bad
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.9.0/.buildinfo b/v9.9.0/.buildinfo
index c475a8d50..5971492d1 100644
--- a/v9.9.0/.buildinfo
+++ b/v9.9.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: 8c53b0a133a6f5fcbb437c2f6d5f5180
+config: df82a16a22c0b5b6a558d2dc95961746
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.9.1/.buildinfo b/v9.9.1/.buildinfo
index 007e04143..66a721fdd 100644
--- a/v9.9.1/.buildinfo
+++ b/v9.9.1/.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: 2b24306712875e7414f85652da34db17
+config: f66ed1e1991e15b1c7324b42d62fe260
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v9.9.2/.buildinfo b/v9.9.2/.buildinfo
index fc6561f4f..8bfcfba53 100644
--- a/v9.9.2/.buildinfo
+++ b/v9.9.2/.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: 2221b034c6e9a73dec58374fc1a27e27
+config: d73bd1fae836a9d0e1fb1ddba4f8403d
 tags: 645f666f9bcd5a90fca523b33c5a78b7