Disable link-preview in Read The Docs and remove hard-coded patches
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 171
- Forks
- 75
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 20
Description
The link-preview extension is injected into our RTD pages (https://docs.readthedocs.com/platform/stable/link-previews.html), giving it some extra functionality.
In #571, however, we discovered it does not play well with sphinx-design cards and other parts of our infrastructure. The same PR introduced a hard-coded patch over the extension.
As mentioned in TODOs (699375a), we may want to revisit these snippets if we move away from Read The Docs eventually.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the Read the Docs link-preview documentation and PR #571, especially commit 699375a and its TODO notes. Locate the configuration that enables the extension and the hard-coded patch introduced there, then verify the documentation build still handles sphinx-design cards correctly after both are removed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100