GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — replaced links in importlib.metadata.rst with sphinx roles by hoefling · Pull Request #17730 · python/cpython

Conversation

@hoefling

@hoefling hoefling commented Dec 28, 2019

Copy link
Copy Markdown
Contributor

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 [email protected]

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@hoefling
links in importlib.metadata.rst replaced with sphinx references
c3d062c
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 <[email protected]>
@the-knights-who-say-ni the-knights-who-say-ni added the CLA signed label Dec 28, 2019
@bedevere-bot bedevere-bot added the awaiting review label Dec 28, 2019
@hoefling

hoefling commented Dec 28, 2019

Copy link
Copy Markdown
Contributor Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@tirkarthi

tirkarthi commented Dec 29, 2019

Copy link
Copy Markdown
Member

cc: @jaraco

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jaraco

jaraco commented Dec 29, 2019

Copy link
Copy Markdown
Member

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?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hoefling

hoefling commented Dec 29, 2019

Copy link
Copy Markdown
Contributor Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jaraco

jaraco commented Dec 29, 2019

Copy link
Copy Markdown
Member

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jaraco

jaraco commented Dec 29, 2019

Copy link
Copy Markdown
Member

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jaraco jaraco added skip issue skip news labels Dec 29, 2019
@jaraco jaraco mentioned this pull request Dec 29, 2019
bpo-37860: Add netlify deploy preview for docs #15288
Merged
@hoefling

hoefling commented Dec 29, 2019

Copy link
Copy Markdown
Contributor Author

@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 :)

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jaraco
jaraco merged commit cbd0408 into python:master Dec 29, 2019
@bedevere-bot bedevere-bot removed the awaiting review label Dec 29, 2019
@jaraco

jaraco commented Dec 29, 2019

Copy link
Copy Markdown
Member

Thanks for the extra effort required of the backport!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@hoefling

hoefling commented Dec 30, 2019

Copy link
Copy Markdown
Contributor Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jan 31, 2020
@hoefling @shihai1991
links in importlib.metadata.rst replaced with sphinx references (pyth…
737dd4e
…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 <[email protected]>
dzbarsky pushed a commit to dzbarsky/importlib_metadata that referenced this pull request Mar 9, 2020
@hoefling
backport patch from python/cpython#17730 PR
58b0fa0
Signed-off-by: Oleg Höfling <[email protected]>
dzbarsky pushed a commit to dzbarsky/importlib_metadata that referenced this pull request Mar 9, 2020
@jaraco
Merge branch 'master' into 'master'
e098c1f
Backport of PR python/cpython#17730

See merge request python-devs/importlib_metadata!105
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@hoefling @tirkarthi @jaraco @the-knights-who-say-ni @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.