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 --- v8.1.0/_sources/changelog.rst.txt | 170 +++++++++++++++++++++ v8.1.0/_sources/development.rst.txt | 2 + v8.1.0/_sources/index.rst.txt | 31 ++++ v8.1.0/_sources/output/botcore.async_stats.rst.txt | 7 + v8.1.0/_sources/output/botcore.exts.rst.txt | 7 + v8.1.0/_sources/output/botcore.rst.txt | 25 +++ v8.1.0/_sources/output/botcore.site_api.rst.txt | 7 + .../_sources/output/botcore.utils.caching.rst.txt | 7 + .../_sources/output/botcore.utils.channel.rst.txt | 7 + .../_sources/output/botcore.utils.commands.rst.txt | 7 + .../output/botcore.utils.interactions.rst.txt | 7 + .../_sources/output/botcore.utils.logging.rst.txt | 7 + .../_sources/output/botcore.utils.members.rst.txt | 7 + v8.1.0/_sources/output/botcore.utils.regex.rst.txt | 7 + v8.1.0/_sources/output/botcore.utils.rst.txt | 22 +++ .../output/botcore.utils.scheduling.rst.txt | 7 + 16 files changed, 327 insertions(+) create mode 100644 v8.1.0/_sources/changelog.rst.txt create mode 100644 v8.1.0/_sources/development.rst.txt create mode 100644 v8.1.0/_sources/index.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.async_stats.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.exts.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.site_api.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.utils.caching.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.utils.channel.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.utils.commands.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.utils.interactions.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.utils.logging.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.utils.members.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.utils.regex.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.utils.rst.txt create mode 100644 v8.1.0/_sources/output/botcore.utils.scheduling.rst.txt (limited to 'v8.1.0/_sources') diff --git a/v8.1.0/_sources/changelog.rst.txt b/v8.1.0/_sources/changelog.rst.txt new file mode 100644 index 00000000..643a54fc --- /dev/null +++ b/v8.1.0/_sources/changelog.rst.txt @@ -0,0 +1,170 @@ +.. See docs for details on formatting your entries + https://releases.readthedocs.io/en/latest/concepts.html + +Changelog +========= +- :release:`8.1.0 <16th August 2022>` +- :support:`124` Updated :obj:`botcore.utils.regex.DISCORD_INVITE` regex to optionally match leading "http[s]" and "www". + + +- :release:`8.0.0 <27th July 2022>` +- :breaking:`110` Bump async-rediscache to v1.0.0-rc2 +- :support:`108` Bump Python version to 3.10.* +- :bug:`107 major` Declare aiodns as a project dependency. +- :support:`107` Add a sample project with boilerplate and documentation explaining how to develop for bot-core. + + +- :release:`7.5.0 <23rd July 2022>` +- :feature:`101` Add a utility to clean a string or referenced message's content + + +- :release:`7.4.0 <17th July 2022>` +- :feature:`106` Add an optional ``message`` attr to :obj:`botcore.utils.interactions.ViewWithUserAndRoleCheck`. On view timeout, this message has its view removed if set. + + +- :release:`7.3.1 <16th July 2022>` +- :bug:`104` Fix :obj:`botcore.utils.interactions.DeleteMessageButton` not working due to using wrong delete method. + + +- :release:`7.3.0 <16th July 2022>` +- :feature:`103` Add a generic view :obj:`botcore.utils.interactions.ViewWithUserAndRoleCheck` that only allows specified users and roles to interaction with it +- :feature:`103` Add a button :obj:`botcore.utils.interactions.DeleteMessageButton` that deletes the message attached to its parent view. + + +- :release:`7.2.2 <9th July 2022>` +- :bug:`98` Only close ``BotBase.stats._transport`` if ``BotBase.stats`` was created + + +- :release:`7.2.1 <30th June 2022>` +- :bug:`96` Fix attempts to connect to ``BotBase.statsd_url`` when it is None. +- :bug:`91` Fix incorrect docstring for ``botcore.utils.member.handle_role_change``. +- :bug:`91` Pass missing self parameter to ``BotBase.ping_services``. +- :bug:`91` Add missing await to ``BotBase.ping_services`` in some cases. + + +- :release:`7.2.0 <28th June 2022>` +- :support:`93` Bump Discord.py to :literal-url:`0eb3d26 `: + + - Adds support for auto mod, of which the new auto_mod MESSAGE_TYPE is needed for our filter system. + + +- :release:`7.1.3 <30th May 2022>` 79 +- :support:`79` Add `sphinx-multiversion `_ to make available older doc versions. +- :support:`79` Restore on-site changelog. + + +- :release:`7.1.0 <24th May 2022>` +- :feature:`78` Bump Discord.py to :literal-url:`4cbe8f5 `: + + - This fixes a bug with permission resolution when dealing with timed out members. + + +- :release:`7.0.0 <10th May 2022>` +- :bug:`75 major` Capture all characters up to a whitespace in the Discord Invite regex. +- :breaking:`75` Discord invite regex no longer returns a URL safe result, refer to documentation for safely handling it. + + +- :release:`6.4.0 <26th April 2022>` +- :feature:`72` Bump discord.py to :literal-url:`5a06fa5 `: + + - Notably, one of the commits in this bump dynamically extends the timeout of ``Guild.chunk()`` based on the number or members, so it should actually work on our guild now. + + +- :release:`6.3.2 <25th April 2022>` +- :bug:`69` Actually use ``statsd_url`` when it gets passed to ``BotBase``. + + +- :release:`6.3.1 <21st April 2022>` +- :bug:`68` Correct version number in pyproject.toml + + +- :release:`6.3.0 <21st April 2022>` +- :feature:`-` (Committed directly to main) Don't load modules starting with ``_`` + + +- :release:`6.2.0 <21st April 2022>` +- :feature:`66` Load each cog in it's own task to avoid a single cog crashing entire load process. + + +- :release:`6.1.0 <20th April 2022>` +- :feature:`65` Add ``unqualify`` to the ``botcore.utils`` namespace for use in bots that manipulate extensions. + + +- :release:`6.0.0 <19th April 2022>` +- :breaking:`64` Bump discord.py to :literal-url:`987235d `: + + - This reverts a change to help command behaviour that broke our custom pagination + - This also adds basic forum channel support to discord.py + + +- :release:`5.0.4 <18th April 2022>` 63 + + .. + Feature 63 Needs to be explicitly included above because it was improperly released within a bugfix version + instead of a minor release + +- :feature:`63` Allow passing an ``api_client`` to ``BotBase.__init__`` to specify the ``botcore.site_api.APIClient`` instance to use. + + +- :release:`5.0.3 <18th April 2022>` +- :bug:`61` Reconnect to redis session on setup if it is closed. + + +- :release:`5.0.2 <5th April 2022>` +- :bug:`56` Create a dummy ``AsyncstatsdClient`` before connecting to real url, in case a connection cannot be made on init. +- :bug:`56` Move the creation of the ``asyncio.Event``, ``BotBase._guild_available`` to within the setup hook, to avoid a deprecation notice. + + +- :release:`5.0.1 <2nd April 2022>` +- :bug:`54` Move creation of BotBase's ``aiohttp.AsyncResolver`` to the async setup hook, to avoid deprecation notice + + +- :release:`5.0.0 <2nd April 2022>` +- :breaking:`42` Remove public extensions util. +- :feature:`42` Add ``BotBase``, a ``discord.ext.commands.Bot`` sub-class, which abstracts a lot of logic shared between our bots. +- :feature:`42` Add async statsd client. +- :support:`42` Bump Discord.py to latest alpha commit. + + +- :release:`4.0.0 <14th March 2022>` +- :breaking:`39` Migrate back to Discord.py 2.0. + + +- :release:`3.0.1 <5th March 2022>` +- :bug:`37` Setup log tracing when ``botcore.utils.logging`` is imported so that it can be used within botcore functions. + + +- :release:`3.0.0 <3rd March 2022>` +- :breaking:`35` Move ``apply_monkey_patches()`` directly to `botcore.utils` namespace. + + +- :release:`2.1.0 <24th February 2022>` +- :feature:`34` Port the Site API wrapper from the bot repo. + + +- :release:`2.0.0 <22nd February 2022>` +- :breaking:`35` Moved regex to ``botcore.utils`` namespace +- :breaking:`32` Migrate from discord.py 2.0a0 to disnake. +- :feature:`32` Add common monkey patches. +- :feature:`29` Port many common utilities from our bots: + + - caching + - channel + - extensions + - loggers + - members + - scheduling +- :support:`2` Added intersphinx to docs. + + +- :release:`1.2.0 <9th January 2022>` +- :feature:`12` Code block detection regex. + + +- :release:`1.1.0 <2nd December 2021>` +- :support:`2` Autogenerated docs. +- :feature:`2` Regex utility. + + +- :release:`1.0.0 <17th November 2021>` +- :feature:`1` Core package, poetry, and linting CI. diff --git a/v8.1.0/_sources/development.rst.txt b/v8.1.0/_sources/development.rst.txt new file mode 100644 index 00000000..25b8e0a7 --- /dev/null +++ b/v8.1.0/_sources/development.rst.txt @@ -0,0 +1,2 @@ +.. Stub file to expose the README to sphinx +.. include:: ../dev/README.rst diff --git a/v8.1.0/_sources/index.rst.txt b/v8.1.0/_sources/index.rst.txt new file mode 100644 index 00000000..aee7b269 --- /dev/null +++ b/v8.1.0/_sources/index.rst.txt @@ -0,0 +1,31 @@ +.. Generated by sphinx-quickstart on Thu Dec 2 01:21:15 2021. + +Bot Core Project Documentation +============================== + + +Reference +==================================== + +.. toctree:: + :maxdepth: 4 + :caption: Modules: + + output/botcore + +.. toctree:: + :caption: Other: + :hidden: + + development + changelog + + +Extras +================== + +* :ref:`genindex` +* :ref:`search` +* :repo-file:`Information ` +* :doc:`development` +* :doc:`changelog` diff --git a/v8.1.0/_sources/output/botcore.async_stats.rst.txt b/v8.1.0/_sources/output/botcore.async_stats.rst.txt new file mode 100644 index 00000000..7fdbbbe2 --- /dev/null +++ b/v8.1.0/_sources/output/botcore.async_stats.rst.txt @@ -0,0 +1,7 @@ +async\_stats +=========================== + +.. automodule:: botcore.async_stats + :members: + :special-members: + :show-inheritance: diff --git a/v8.1.0/_sources/output/botcore.exts.rst.txt b/v8.1.0/_sources/output/botcore.exts.rst.txt new file mode 100644 index 00000000..38d2fc2e --- /dev/null +++ b/v8.1.0/_sources/output/botcore.exts.rst.txt @@ -0,0 +1,7 @@ +Exts +==== + +.. automodule:: botcore.exts + :members: + :special-members: + :show-inheritance: diff --git a/v8.1.0/_sources/output/botcore.rst.txt b/v8.1.0/_sources/output/botcore.rst.txt new file mode 100644 index 00000000..0a719da2 --- /dev/null +++ b/v8.1.0/_sources/output/botcore.rst.txt @@ -0,0 +1,25 @@ +Botcore +======= + +.. automodule:: botcore + :members: + :special-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + botcore.exts + botcore.utils + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + botcore.async_stats + botcore.site_api diff --git a/v8.1.0/_sources/output/botcore.site_api.rst.txt b/v8.1.0/_sources/output/botcore.site_api.rst.txt new file mode 100644 index 00000000..2399bbc4 --- /dev/null +++ b/v8.1.0/_sources/output/botcore.site_api.rst.txt @@ -0,0 +1,7 @@ +site\_api +======================== + +.. automodule:: botcore.site_api + :members: + :special-members: + :show-inheritance: diff --git a/v8.1.0/_sources/output/botcore.utils.caching.rst.txt b/v8.1.0/_sources/output/botcore.utils.caching.rst.txt new file mode 100644 index 00000000..02c2105d --- /dev/null +++ b/v8.1.0/_sources/output/botcore.utils.caching.rst.txt @@ -0,0 +1,7 @@ +caching +============================ + +.. automodule:: botcore.utils.caching + :members: + :special-members: + :show-inheritance: diff --git a/v8.1.0/_sources/output/botcore.utils.channel.rst.txt b/v8.1.0/_sources/output/botcore.utils.channel.rst.txt new file mode 100644 index 00000000..460975f4 --- /dev/null +++ b/v8.1.0/_sources/output/botcore.utils.channel.rst.txt @@ -0,0 +1,7 @@ +channel +============================ + +.. automodule:: botcore.utils.channel + :members: + :special-members: + :show-inheritance: diff --git a/v8.1.0/_sources/output/botcore.utils.commands.rst.txt b/v8.1.0/_sources/output/botcore.utils.commands.rst.txt new file mode 100644 index 00000000..00ef02f6 --- /dev/null +++ b/v8.1.0/_sources/output/botcore.utils.commands.rst.txt @@ -0,0 +1,7 @@ +commands +============================= + +.. automodule:: botcore.utils.commands + :members: + :special-members: + :show-inheritance: diff --git a/v8.1.0/_sources/output/botcore.utils.interactions.rst.txt b/v8.1.0/_sources/output/botcore.utils.interactions.rst.txt new file mode 100644 index 00000000..bb8be82c --- /dev/null +++ b/v8.1.0/_sources/output/botcore.utils.interactions.rst.txt @@ -0,0 +1,7 @@ +interactions +================================= + +.. automodule:: botcore.utils.interactions + :members: + :special-members: + :show-inheritance: diff --git a/v8.1.0/_sources/output/botcore.utils.logging.rst.txt b/v8.1.0/_sources/output/botcore.utils.logging.rst.txt new file mode 100644 index 00000000..a719bfa7 --- /dev/null +++ b/v8.1.0/_sources/output/botcore.utils.logging.rst.txt @@ -0,0 +1,7 @@ +logging +============================ + +.. automodule:: botcore.utils.logging + :members: + :special-members: + :show-inheritance: diff --git a/v8.1.0/_sources/output/botcore.utils.members.rst.txt b/v8.1.0/_sources/output/botcore.utils.members.rst.txt new file mode 100644 index 00000000..ab65d36b --- /dev/null +++ b/v8.1.0/_sources/output/botcore.utils.members.rst.txt @@ -0,0 +1,7 @@ +members +============================ + +.. automodule:: botcore.utils.members + :members: + :special-members: + :show-inheritance: diff --git a/v8.1.0/_sources/output/botcore.utils.regex.rst.txt b/v8.1.0/_sources/output/botcore.utils.regex.rst.txt new file mode 100644 index 00000000..405e416a --- /dev/null +++ b/v8.1.0/_sources/output/botcore.utils.regex.rst.txt @@ -0,0 +1,7 @@ +regex +========================== + +.. automodule:: botcore.utils.regex + :members: + :special-members: + :show-inheritance: diff --git a/v8.1.0/_sources/output/botcore.utils.rst.txt b/v8.1.0/_sources/output/botcore.utils.rst.txt new file mode 100644 index 00000000..a954585c --- /dev/null +++ b/v8.1.0/_sources/output/botcore.utils.rst.txt @@ -0,0 +1,22 @@ +Utils +===== + +.. automodule:: botcore.utils + :members: + :special-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + botcore.utils.caching + botcore.utils.channel + botcore.utils.commands + botcore.utils.interactions + botcore.utils.logging + botcore.utils.members + botcore.utils.regex + botcore.utils.scheduling diff --git a/v8.1.0/_sources/output/botcore.utils.scheduling.rst.txt b/v8.1.0/_sources/output/botcore.utils.scheduling.rst.txt new file mode 100644 index 00000000..41ffe1c6 --- /dev/null +++ b/v8.1.0/_sources/output/botcore.utils.scheduling.rst.txt @@ -0,0 +1,7 @@ +scheduling +=============================== + +.. automodule:: botcore.utils.scheduling + :members: + :special-members: + :show-inheritance: -- cgit v1.2.3