Add Inventory method to check for/report duplicate objects

bskinn / sphobjinv

Toolkit for manipulation and inspection of Sphinx objects.inv files

https://sphobjinv.readthedocs.io

MIT License

78 stars 9 forks source link

Add Inventory method to check for/report duplicate objects #177

Open bskinn opened 3 years ago

bskinn commented 3 years ago

Possibly YAGNI, but seems like it would be useful to have direct access to whether duplicate :domain:role:name entries exist, and what they are, since duplicates (probably?) can't be reliably referenced.

API function(s), definitely. Have to think about the interface.

Could also add a CLI subparser...might be useful as a CI check. Pretty sure I'd use it! Again, have to think about the interface.

bskinn commented 1 year ago

Related to #187. Multiple things going on here, need to tease them apart.

First stab:

User-initiated check functionality
- Duplicates
- Lines that don't load in Sphinx? Would require Sphinx as an extra_requires, probably.
Automatic warning of questionable object situations (duplicates, lines not loading?)