This repository was archived by the owner on Apr 9, 2025. It is now read-only.
Add a note about the deprecation of this extension #337
Conversation
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
|
How it renders on GitHub (not ideal, I'd say): https://github.com/agriyakhetarpal/sphinx-hoverxref/tree/note/deprecated-status-of-repository |
humitos
reviewed
Apr 9, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
See #312
This PR updates the README to reflect the current deprecated status of this Sphinx extension, and advises users to switch to the Read the Docs addons.
Unfortunately, the README is in reStructuredText, for which GitHub's admonitions do not render properly. There has been a workaround that no longer works due to this issue: github/markup#1682.
I tried to use raw HTML to render the "Warning" as a heading in yellow ochre, but it didn't work that way – the only way to make it more prominent is to convert this document to Markdown.
📚 Documentation preview 📚: https://sphinx-hoverxref--337.org.readthedocs.build/en/337/