diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/changelog.rst | 26 | ||||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/utils.py | 12 |
3 files changed, 22 insertions, 18 deletions
diff --git a/docs/changelog.rst b/docs/changelog.rst index 3e3c7149..819e7d38 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -4,6 +4,10 @@ Changelog ========= +- :release:`9.0.0 <5th November 2022>` +- :breaking:`157` Rename project to pydis_core to allow for publishing to pypi. + + - :release:`8.2.1 <18th September 2022>` - :bug:`138` Bump Discord.py to :literal-url:`2.0.1 <https://discordpy.readthedocs.io/en/latest/whats_new.html#v2-0-1>`. @@ -13,7 +17,7 @@ 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". +- :support:`124` Updated :obj:`pydis_core.utils.regex.DISCORD_INVITE` regex to optionally match leading "http[s]" and "www". - :release:`8.0.0 <27th July 2022>` @@ -28,16 +32,16 @@ Changelog - :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. +- :feature:`106` Add an optional ``message`` attr to :obj:`pydis_core.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. +- :bug:`104` Fix :obj:`pydis_core.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. +- :feature:`103` Add a generic view :obj:`pydis_core.utils.interactions.ViewWithUserAndRoleCheck` that only allows specified users and roles to interaction with it +- :feature:`103` Add a button :obj:`pydis_core.utils.interactions.DeleteMessageButton` that deletes the message attached to its parent view. - :release:`7.2.2 <9th July 2022>` @@ -46,7 +50,7 @@ Changelog - :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` Fix incorrect docstring for ``pydis_core.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. @@ -96,7 +100,7 @@ Changelog - :release:`6.1.0 <20th April 2022>` -- :feature:`65` Add ``unqualify`` to the ``botcore.utils`` namespace for use in bots that manipulate extensions. +- :feature:`65` Add ``unqualify`` to the ``pydis_core.utils`` namespace for use in bots that manipulate extensions. - :release:`6.0.0 <19th April 2022>` @@ -112,7 +116,7 @@ Changelog 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. +- :feature:`63` Allow passing an ``api_client`` to ``BotBase.__init__`` to specify the ``pydis_core.site_api.APIClient`` instance to use. - :release:`5.0.3 <18th April 2022>` @@ -140,11 +144,11 @@ Changelog - :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. +- :bug:`37` Setup log tracing when ``pydis_core.utils.logging`` is imported so that it can be used within pydis_core functions. - :release:`3.0.0 <3rd March 2022>` -- :breaking:`35` Move ``apply_monkey_patches()`` directly to `botcore.utils` namespace. +- :breaking:`35` Move ``apply_monkey_patches()`` directly to `pydis_core.utils` namespace. - :release:`2.1.0 <24th February 2022>` @@ -152,7 +156,7 @@ Changelog - :release:`2.0.0 <22nd February 2022>` -- :breaking:`35` Moved regex to ``botcore.utils`` namespace +- :breaking:`35` Moved regex to ``pydis_core.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: diff --git a/docs/index.rst b/docs/index.rst index aee7b269..259d01cc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,7 +11,7 @@ Reference :maxdepth: 4 :caption: Modules: - output/botcore + output/pydis_core .. toctree:: :caption: Other: diff --git a/docs/utils.py b/docs/utils.py index c8bbc895..e7295798 100644 --- a/docs/utils.py +++ b/docs/utils.py @@ -134,12 +134,12 @@ def cleanup() -> None: included = __get_included() for file in (get_build_root() / "docs" / "output").iterdir(): - if file.name in ("botcore.rst", "botcore.exts.rst", "botcore.utils.rst") and file.name in included: + if file.name in ("pydis_core.rst", "pydis_core.exts.rst", "pydis_core.utils.rst") and file.name in included: content = file.read_text(encoding="utf-8").splitlines(keepends=True) # Rename the extension to be less wordy - # Example: botcore.exts -> Botcore Exts - title = content[0].split()[0].strip().replace("botcore.", "").replace(".", " ").title() + # Example: pydis_core.exts -> pydis_core Exts + title = content[0].split()[0].strip().replace("pydis_core.", "").replace(".", " ").title() title = f"{title}\n{'=' * len(title)}\n\n" content = title, *content[3:] @@ -147,7 +147,7 @@ def cleanup() -> None: elif file.name in included: # Clean up the submodule name so it's just the name without the top level module name - # example: `botcore.regex module` -> `regex` + # example: `pydis_core.regex module` -> `regex` lines = file.read_text(encoding="utf-8").splitlines(keepends=True) lines[0] = lines[0].replace("module", "").strip().split(".")[-1] + "\n" file.write_text("".join(lines)) @@ -164,7 +164,7 @@ def cleanup() -> None: def build_api_doc() -> None: """Generate auto-module directives using apidoc.""" - cmd = os.getenv("APIDOC_COMMAND") or "sphinx-apidoc -o docs/output botcore -feM" + cmd = os.getenv("APIDOC_COMMAND") or "sphinx-apidoc -o docs/output pydis_core -feM" cmd = cmd.split() build_root = get_build_root() @@ -196,7 +196,7 @@ def __get_included() -> set[str]: return _modules - return get_all_from_module("botcore") + return get_all_from_module("pydis_core") def reorder_release_entries(release_list: list[releases.Release]) -> None: |