Repository navigation
Conversation
Closes #52. The readme badge for the docs is opt-in per project (keyring and zipp enable it, tempora does not), so the readme is left alone. Adding the entry here is what puts the link on the PyPI page, and it also flows into the rendered docs, whose sidebar already renders the project URLs via `sidebar-links`. Adds newsfragments/52.feature.rst per the contributing guidance.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #52.
The README badge for the docs is opt-in per project -
keyringandzippenable it,
temporadoes not - so the README is deliberately left alone here.Adding the entry to
[project.urls]is what puts a documentation link on thePyPI page, which is where the reporter said they looked and found nothing.
It also flows into the rendered docs for free:
docs/index.rstalready rendersthe project URLs via
sidebar-links.PROJECT_RTDis the same placeholder the README badge already uses, and itresolves per project (in
keyringit becomeskeyring.readthedocs.io).Adds
newsfragments/52.feature.rstper the contributing guidance.One trade-off worth flagging: a derived project with no Read the Docs build
would now publish a dead
Documentationlink on PyPI. Happy to make thisopt-in instead if you prefer - I did not find a
# localmarker convention for[project.urls]that would allow a clean per-project override.