intersphinx-untangled
intersphinx-untangled copied to clipboard
[idea] Explore creating synthetic intesphinx references for non-sphinx resources
<nod>, this is definitely a big gap in the current ecosystem. See bskinn/sphobjinv#148 and bskinn/sphobjinv#19.
High-level, all any given non-Sphinx docset really needs is something (e.g., a webscraper) that identifies all the relevant artifacts and maps the info about them into the objects.inv
data fields structure, which can then be assembled into a proper objects.inv
by sphobjinv
.
A few examples I've found of sphobjinv
users building custom objects.inv
files:
- For Tensorflow
- For Haddock docsets (the Haskell documentation generator)
- A small example, where a project has just a few internal objects it wants to add to an
objects.inv
.
Hey, nice project here!
MVP webscraper could link to the object definition directly in publicly available code (like Github)