Skip to content

Provide Intersphinx objects.inv file for API docs #236

@garrison

Description

@garrison

Feedback

At qiskit.org, there is currently a file called objects.inv: https://qiskit.org/documentation/objects.inv. This file contains information about the identifiers used in Qiskit so that other Sphinx projects can create cross references to the Qiskit API docs. For instance, the Circuit Knitting Toolbox's page on the cut_wires function links to the QuantumCircuit documentation at qiskit.org using this mechanism.

Currently, the objects.inv file is missing from the build at https://docs.quantum-computing.ibm.com/api/qiskit. If the directory structure is the same as is output by Sphinx, then allowing Intersphinx to work may be as simple as including Qiskit's objects.inv in the build. If, however, the directory structure does not match, then objects.inv will need to be adjusted in an automated way to contain correct information.

Other comments

No response

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions