Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
buhtz opened this issue Feb 29, 2024 · 1 comment · May be fixed by #1353
Open

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

buhtz opened this issue Feb 29, 2024 · 1 comment · May be fixed by #1353

Comments

@buhtz
Copy link

buhtz commented Feb 29, 2024

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
Copy link
Contributor

scanny commented Mar 2, 2024

@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.

buhtz added a commit to buhtz/python-docx that referenced this issue Mar 3, 2024
@buhtz buhtz linked a pull request Mar 3, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants