Skip to content

Output metadata to Sphinx's object.inv #28

@adamtheturtle

Description

@adamtheturtle

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions