This repository has been archived by the owner on Nov 16, 2023. It is now read-only.
Duplicated classes and methods in Sphinx API docs #17
Labels
bug
Something isn't working
documentation
Improvements or additions to documentation
help wanted
Extra attention is needed
What is the expected enhancement?
Currently, there is a build of the API reference at https://qiskit-community.github.io/prototype-qrao/apidocs/. However, the use of Sphinx could be improved. Most notably, some classes and functions are duplicated, e.g. on the encoding page. The duplication is presumably because those identifiers are included explicitly in the autosummary directive; however, if identifiers aren't included there, they end up not being clickable for additional detail (e.g., as is currently the case with
EncodingCommutationVerifier
). I've not been able to figure out Sphinx sufficiently to fix this.The text was updated successfully, but these errors were encountered: