Skip to content
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

replaced links in importlib.metadata.rst with sphinx roles #17730

Merged
merged 1 commit into from Dec 29, 2019

Conversation

@hoefling
Copy link
Contributor

hoefling commented Dec 28, 2019

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

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>
@hoefling

This comment has been minimized.

Copy link
Contributor Author

hoefling commented Dec 28, 2019

Dear reviewers, I did create neither an issue on BPO nor a news entry as the fix is IMO a trivial one.

@tirkarthi

This comment has been minimized.

Copy link
Contributor

tirkarthi commented Dec 29, 2019

cc: @jaraco

@jaraco

This comment has been minimized.

Copy link
Member

jaraco commented Dec 29, 2019

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?

@hoefling

This comment has been minimized.

Copy link
Contributor Author

hoefling commented Dec 29, 2019

@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 reference/import.rst , the rest of the changes applies fine.

Is that something you would like to help with?

Sure, I will gladly prepare a separate PR for the backport docs.

@jaraco

This comment has been minimized.

Copy link
Member

jaraco commented Dec 29, 2019

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.

@jaraco

This comment has been minimized.

Copy link
Member

jaraco commented Dec 29, 2019

The good news is that importlib_metadata does run the docs as part of the CI, so if the GitLab merge request is passing, that should be sufficient.

@hoefling

This comment has been minimized.

Copy link
Contributor Author

hoefling commented Dec 29, 2019

@jaraco The pipeline looks good, so I've landed the PR. It has more changes than this one because I also went through the index.rst, so please proceed with caution :)

@jaraco jaraco merged commit cbd0408 into python:master Dec 29, 2019
5 checks passed
5 checks passed
Docs
Details
Azure Pipelines PR #20191228.18 succeeded
Details
bedevere/issue-number Issue report skipped
bedevere/news "skip news" label found
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@jaraco

This comment has been minimized.

Copy link
Member

jaraco commented Dec 29, 2019

Thanks for the extra effort required of the backport!

@hoefling

This comment has been minimized.

Copy link
Contributor Author

hoefling commented Dec 30, 2019

@jaraco gladly, and thank you for a fast response and helpful review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.