bskinn / sphobjinv

Toolkit for manipulation and inspection of Sphinx objects.inv files
https://sphobjinv.readthedocs.io
MIT License
78 stars 7 forks source link

Re-work docs to better highlight the problems sphobjinv solves & how it solves them #270

Open bskinn opened 1 year ago

bskinn commented 1 year ago

Per Discord conversation with @CAM-Gerlach, docs currently are unclear and poorly organized.

This is correct. Indeed, they grew organically from the original v1.0 docs, which were only documenting the convert CLI, to include the new API and the suggest feature.

Time to re-work them, with intentionality. His suggestions, heavily excerpted/summarized:


High level summarize these and point to other places in docs for more info:

Front page:

Possible outline for revised front page: