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

Add module (root) reference #1353

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

buhtz
Copy link

@buhtz buhtz commented Mar 3, 2024

Might fix #1352

Solution was proposed by Sphinx maintainers them self. https://github.com/orgs/sphinx-doc/discussions/12027#discussioncomment-8656546

Now your objects.inv contain the right reference

$ python3 -m sphinx.ext.intersphinx objects.inv | grep module
py:module
	docx                                     index.html#module-docx

It is up to you to decide if you name it "python-docx" (name of distribution package) or "docx" (name of import package). From a users perspective I would prepare to have it named as the import package docx.

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 this pull request may close these issues.

Docu: Reference to root package missing in object.inv file
1 participant