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

plum-dispatch functions don't render well in the documentation #50

Open
4 tasks
garrison opened this issue Dec 10, 2024 · 0 comments
Open
4 tasks

plum-dispatch functions don't render well in the documentation #50

garrison opened this issue Dec 10, 2024 · 0 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@garrison
Copy link
Member

garrison commented Dec 10, 2024

See rendering at https://docs.quantum.ibm.com/api/qiskit-addon-aqc-tensor/simulation

Bugs with the Sphinx output

  • Type annotations are fully qualified, unnecessarily. E.g., will say qiskit_addon_aqc_tensor.simulation.aer.state.QiskitAerMPS instead of QiskitAerMPS.
  • The "parameters" and "return type" for each method should be removed. They're not even correct currently. Instead, probably the best solution is to have them be listed once per function (instead of for each method, too).
  • each method is given a [source] link, but all of them link to the "abstract" method's source code. Ideally, it would link to the correct method in each case.

Additional bugs with docs.quantum.ibm.com rendering

  • The type annotations are clickable links in the Sphinx output, but they are no longer clickable when rendered on docs.quantum.ibm.com.
@garrison garrison added bug Something isn't working documentation Improvements or additions to documentation labels Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant