search

python-openxml / python-docx

Create and modify Word documents with Python
MIT License
4.63k stars 1.13k forks source link

Docu: Reference to root package missing in object.inv file #1352

Open buhtz opened 8 months ago

buhtz commented 8 months ago

As diagnosed here at pydocotor it seems that the object.inv file from seaborn miss a so called "reference to the root package".

That occur the problem that using pydoctor as API doc generator I am not able to reference "docx" (and also not "python-docx") as a package. I can reference all objects (functions, methods, classes) without problems. But the package itself I can not.

scanny commented 8 months ago

@buhtz I'm not sure where object.inv files come from, I expect it has something to do with the Sphinx documentation tool-chain.

The Sphinx setup on this project is pretty old now, having been established almost 15 years ago now so I expect those weren't a thing at the time. This is the first I'm hearing of it.

We're probably unlikely to update the Sphinx setup anytime soon since it works and we're mostly in maintenance mode.

If you can determine just what it would take to add that and if it's quick and easy, we'll consider it for the next release.