Skip to content
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

Open
garrison opened this issue May 19, 2022 · 0 comments
Open

Duplicated classes and methods in Sphinx API docs #17

garrison opened this issue May 19, 2022 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@garrison
Copy link
Member

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.

@garrison garrison added bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed labels May 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant