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

Output metadata to Sphinx's object.inv #28

Open
adamtheturtle opened this issue Apr 13, 2021 · 1 comment
Open

Output metadata to Sphinx's object.inv #28

adamtheturtle opened this issue Apr 13, 2021 · 1 comment

Comments

@adamtheturtle
Copy link
Contributor

With the Python domain, one can use code like the following:

.. py:function:: spam(eggs)
                 ham(eggs)

   Spam or ham the foo.

With this, the py:function will be in the objects.inv file which is generated when the documentation is built:

~> python -m sphinx.ext.intersphinx ./build/html/objects.inv
py:function
	target                                   index.html#target
...

The same happens with C++ code wh

However, when the Sphinx Bazel domain is used, nothing is outputted to objects.inv.

When an object is referenced in objects.inv, there are multiple features available.

The one that I am interested in is to have the Bazel rules referenced in a Dash index using doc2dash.

@adamtheturtle
Copy link
Contributor Author

I believe that this means implementing get_objects in BazelDomain.

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

No branches or pull requests

1 participant