New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docs] Change links to d.py docs to use pinned version instead of v1.0.1. #3053
[Docs] Change links to d.py docs to use pinned version instead of v1.0.1. #3053
Conversation
We don't install stable, we pin a specific version for concerns with compatability with overriding certain behaviors in discord.ext.commands
For most cases for our documentation, we should point to the current pinned version (which would still need to be updated here)
Even then 1.0.1 it’s outdated right? Iirc the correct version is 1.2.3 something ? |
I was alluding to that with this portion
It's just not necessarily fine to link to stable |
I added Yes, I could have used intersphinx for d.py links, but I figured extlinks are easier to use as you don't need to look up #### this is how extlinks works
# https://discordpy.readthedocs.io/en/v1.2.3/discord.html#creating-a-bot-account
:dpy_docs:`this guide <discord.html#creating-a-bot-account>`
# https://discordpy.readthedocs.io/en/v1.2.3/migrating.html
:dpy_docs:`discord.py's migration guide <migrating.html>`
#### this is how intersphinx works for roughly the same links
# https://discordpy.readthedocs.io/en/v1.2.3/discord.html#discord-intro
:ref:`this guide <dpy:discord-intro>`
# https://discordpy.readthedocs.io/en/v1.2.3/migrating.html
:doc:`discord.py's migration guide <dpy:migrating>` Another note, while this covers most of links to d.py docs, it can't cover all of them, especially the ones in help docstrings. This might be added as another substitution in #3063 or possibly in this (or a separate) PR after #3063 gets merged. For anyone looking for this in a future, currently the one and only place that is not covered by this PR is here |
Looks good to go. A quick change to the changelog to reflect the new approach and I'll get this merged.
Type
Description of the changes
I grepped for
discordpy
to find all files that needed to be updated.