Skip to content

Commit b80fedc

Browse files
committed
fix(docs): fix linkcheck issues
1 parent 1c62306 commit b80fedc

File tree

17 files changed

+41
-39
lines changed

17 files changed

+41
-39
lines changed

.github/workflows/docs-checks.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ on:
1717
- "*.toml"
1818
- "*.py"
1919
workflow_dispatch:
20+
inputs:
21+
with_linkcheck:
22+
type: boolean
23+
description: "Whether to run the linkcheck"
24+
default: true
2025
schedule:
2126
- cron: "0 0 * * *"
2227

@@ -44,7 +49,7 @@ jobs:
4449
python -m pip install -U pip
4550
pip install ".[docs]"
4651
- name: "Check Links"
47-
if: ${{ github.event_name == 'schedule' }}
52+
if: ${{ github.event_name == 'schedule' || inputs.with_linkcheck }}
4853
run: |
4954
cd docs
5055
make linkcheck

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,7 @@ docs/changelog.md
186186
# Translations
187187
docs/build/html
188188
docs/build/doctrees
189+
docs/build/linkcheck
189190
!docs/build/locales/*
190191
*.mo
191192
!docs/locales/*

CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,6 @@ These changes are available on the `master` branch, but have not yet been releas
322322
([#2185](https://github.com/Pycord-Development/pycord/pull/2185))
323323
- Fixed inaccurate `Union` type hint of `values` argument of `basic_autocomplete` to
324324
include `Iterable[OptionChoice]`.
325-
([#2164](https://github.com/Pycord-Development/pycord/pull/2164))
326325
- Fixed initial message inside of the create thread payload sending legacy beta payload.
327326
([#2191](https://github.com/Pycord-Development/pycord/pull/2191))
328327
- Fixed a misplaced payload object inside of the thread creation payload.
@@ -652,7 +651,7 @@ These changes are available on the `master` branch, but have not yet been releas
652651

653652
- Fix `VoiceChannel`/`CategoryChannel` data being invalidated on `Option._invoke`.
654653
([#1490](https://github.com/Pycord-Development/pycord/pull/1490))
655-
- Fix type issues in options.py
654+
- Fix type issues in `options.py`
656655
([#1473](https://github.com/Pycord-Development/pycord/pull/1473))
657656
- Fix KeyError on AutoModActionExecution when the bot lacks the Message Content Intent.
658657
([#1521](https://github.com/Pycord-Development/pycord/pull/1521))
@@ -903,7 +902,7 @@ These changes are available on the `master` branch, but have not yet been releas
903902
([#1240](https://github.com/Pycord-Development/pycord/pull/1240))
904903

905904
[unreleased]: https://github.com/Pycord-Development/pycord/compare/v2.6.0...HEAD
906-
[2.6.0]: https://github.com/Pycord-Development/pycord/compare/v2.5.0...2.6.0
905+
[2.6.0]: https://github.com/Pycord-Development/pycord/compare/v2.5.0...v2.6.0
907906
[2.5.0]: https://github.com/Pycord-Development/pycord/compare/v2.4.1...v2.5.0
908907
[2.4.1]: https://github.com/Pycord-Development/pycord/compare/v2.4.0...v2.4.1
909908
[2.4.0]: https://github.com/Pycord-Development/pycord/compare/v2.3.3...v2.4.0

discord/guild.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ class Guild(Hashable):
210210
features: List[:class:`str`]
211211
A list of features that the guild has. The features that a guild can have are
212212
subject to arbitrary change by Discord. You can find a catalog of guild features
213-
`here <https://github.com/Delitefully/DiscordLists#guild-feature-glossary>`_.
213+
`here <https://github.com/Delitefully/DiscordLists?tab=readme-ov-file#guild-feature-glossary>`_.
214214
premium_tier: :class:`int`
215215
The premium tier for this guild. Corresponds to "Nitro Server" in the official UI.
216216
The number goes from 0 to 3 inclusive.

docs/build/locales/api/models.pot

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7434,7 +7434,7 @@ msgstr ""
74347434

74357435
#: ../../../discord/guild.py:docstring of discord.guild.Guild:141
74367436
#: 96094a79a794453ca947a68e85a7ac9d
7437-
msgid "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists#guild-feature-glossary>`_."
7437+
msgid "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists?tab=readme-ov-file#guild-feature-glossary>`_."
74387438
msgstr ""
74397439

74407440
#: ../../../discord/automod.py:docstring of discord.automod.AutoModTriggerMetadata:29

docs/conf.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,14 @@ def write_new():
480480
r"https://discord.com/developers/docs/.*#",
481481
r"https://support(?:-dev)?.discord.com/hc/en-us/articles/.*",
482482
r"https://dis.gd/contact",
483+
r"https://guide.pycord.dev/",
484+
r"https://guide.pycord.dev/.*",
485+
r"https://pycord.dev/",
486+
r"https://pycord.dev/.*"
487+
]
488+
489+
linkcheck_anchors_ignore_for_url = [
490+
r"https://github.com/Delitefully/DiscordLists"
483491
]
484492

485493
modindex_common_prefix = ["discord."]

docs/locales/de/LC_MESSAGES/api/models.po

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1727,8 +1727,8 @@ msgstr "The guild's notification settings."
17271727
msgid ":class:`NotificationLevel`"
17281728
msgstr ":class:`NotificationLevel`"
17291729

1730-
msgid "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists#guild-feature-glossary>`_."
1731-
msgstr "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists#guild-feature-glossary>`_."
1730+
msgid "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists?tab=readme-ov-file#guild-feature-glossary>`_."
1731+
msgstr "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists?tab=readme-ov-file#guild-feature-glossary>`_."
17321732

17331733
msgid "List[:class:`str`]"
17341734
msgstr "List[:class:`str`]"
@@ -7801,4 +7801,3 @@ msgstr "These are typically given for channel follower webhooks."
78017801

78027802
msgid "Represents a partial channel for webhooks."
78037803
msgstr "Represents a partial channel for webhooks."
7804-

docs/locales/es/LC_MESSAGES/api/models.po

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1727,8 +1727,8 @@ msgstr "The guild's notification settings."
17271727
msgid ":class:`NotificationLevel`"
17281728
msgstr ":class:`NotificationLevel`"
17291729

1730-
msgid "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists#guild-feature-glossary>`_."
1731-
msgstr "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists#guild-feature-glossary>`_."
1730+
msgid "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists?tab=readme-ov-file#guild-feature-glossary>`_."
1731+
msgstr "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists?tab=readme-ov-file#guild-feature-glossary>`_."
17321732

17331733
msgid "List[:class:`str`]"
17341734
msgstr "List[:class:`str`]"
@@ -7801,4 +7801,3 @@ msgstr "These are typically given for channel follower webhooks."
78017801

78027802
msgid "Represents a partial channel for webhooks."
78037803
msgstr "Represents a partial channel for webhooks."
7804-

docs/locales/fr/LC_MESSAGES/api/models.po

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1727,8 +1727,8 @@ msgstr "The guild's notification settings."
17271727
msgid ":class:`NotificationLevel`"
17281728
msgstr ":class:`NotificationLevel`"
17291729

1730-
msgid "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists#guild-feature-glossary>`_."
1731-
msgstr "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists#guild-feature-glossary>`_."
1730+
msgid "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists?tab=readme-ov-file#guild-feature-glossary>`_."
1731+
msgstr "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists?tab=readme-ov-file#guild-feature-glossary>`_."
17321732

17331733
msgid "List[:class:`str`]"
17341734
msgstr "List[:class:`str`]"
@@ -7801,4 +7801,3 @@ msgstr "These are typically given for channel follower webhooks."
78017801

78027802
msgid "Represents a partial channel for webhooks."
78037803
msgstr "Represents a partial channel for webhooks."
7804-

docs/locales/hi/LC_MESSAGES/api/models.po

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1727,8 +1727,8 @@ msgstr "The guild's notification settings."
17271727
msgid ":class:`NotificationLevel`"
17281728
msgstr ":class:`NotificationLevel`"
17291729

1730-
msgid "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists#guild-feature-glossary>`_."
1731-
msgstr "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists#guild-feature-glossary>`_."
1730+
msgid "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists?tab=readme-ov-file#guild-feature-glossary>`_."
1731+
msgstr "A list of features that the guild has. The features that a guild can have are subject to arbitrary change by Discord. You can find a catalog of guild features `here <https://github.com/Delitefully/DiscordLists?tab=readme-ov-file#guild-feature-glossary>`_."
17321732

17331733
msgid "List[:class:`str`]"
17341734
msgstr "List[:class:`str`]"
@@ -7801,4 +7801,3 @@ msgstr "These are typically given for channel follower webhooks."
78017801

78027802
msgid "Represents a partial channel for webhooks."
78037803
msgstr "Represents a partial channel for webhooks."
7804-

0 commit comments

Comments
 (0)