replaced links in importlib.metadata.rst with sphinx roles#17730
Conversation
The importlib.metadata documentation uses hardcoded links to internal pages. This results in minor rendering issues. This change replaces the hardcoded links with suitable Sphinx roles. Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
|
Dear reviewers, I did create neither an issue on BPO nor a news entry as the fix is IMO a trivial one. |
Sorry, something went wrong.
|
Thanks for this. I agree the changes are beneficial. I need to figure out how these changes reconcile with the back port. I don’t think these Sphinx roles exist in the Sphinx environment in which the backport docs render. It might be time, however, to defer all significant docs to CPython (and remove them from the backport). Is that something you would like to help with? |
Sorry, something went wrong.
|
@jaraco Am I right about this being the corresponding backport's doc? I have tried to apply the patch from this PR and besides referring to a new label I have introduced in
Sure, I will gladly prepare a separate PR for the backport docs. |
Sorry, something went wrong.
|
Thanks Oleg. Yes, that's the doc. I'd have provided a link but was on my mobile at the time. I think the main problem you're going to find is that the Sphinx roles aren't configured for the docs builds on the backport. Perhaps they should be. |
Sorry, something went wrong.
|
The good news is that |
Sorry, something went wrong.
|
@jaraco The pipeline looks good, so I've landed the PR. It has more changes than this one because I also went through the |
Sorry, something went wrong.
|
Thanks for the extra effort required of the backport! |
Sorry, something went wrong.
|
@jaraco gladly, and thank you for a fast response and helpful review! |
Sorry, something went wrong.
…onGH-17730) The importlib.metadata documentation uses hardcoded links to internal pages. This results in minor rendering issues. This change replaces the hardcoded links with suitable Sphinx roles. Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com>
Backport of PR python/cpython#17730 See merge request python-devs/importlib_metadata!105
The importlib.metadata documentation uses hardcoded links to internal
pages. This results in minor rendering issues. This change replaces
the hardcoded links with suitable Sphinx roles.
Signed-off-by: Oleg Höfling oleg.hoefling@gmail.com