Intersphinx inventory
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 228
- PR merge metrics
- No merged PRs in 30d
Description
Problem Description
I want to crosslink APIs and validate that links don’t break
Proposal
pdoc should create an intersphinx inventory, like MkDocs can do, and host it as objects.inv next to the root index.html
Alternatives
None, validating hundreds of HTML links per document build per project isn’t feasible.
Additional context
- a parser in Python: https://github.com/bskinn/sphobjinv
- sphinx extension docs: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
Contributor guide
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
Start by reviewing how pdoc writes the root index.html, then read the linked sphobjinv parser and Sphinx intersphinx extension documentation. The work is complete when pdoc generates an intersphinx inventory and hosts it as objects.inv next to the root index.html.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100