We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Part of #479. This issue is focused on the visual design of the API docs.
Right now, API docs are not using design elements to accurately reflect information hierarchy. For example, no colors or indentation.
This is an example class:
Some methods:
A standalone function, but note that it starts after the Return type QasmQobj | PulseQobj text:
Return type QasmQobj | PulseQobj
These screenshots come from our repository for the Qiskit Sphinx Theme, the files starting with api-docs-: https://github.com/Qiskit/qiskit_sphinx_theme/tree/main/tests/js/tests.js-snapshots
api-docs-
A class with methods:
A module page showing a standalone function
The text was updated successfully, but these errors were encountered:
@Eric-Arellano Here are the breakpoints for the API Docs styling. To the right please find a version without indentation for initial implementation
Sorry, something went wrong.
Thanks! Implementation is tracked by #735 and #736, where I also put screenshots.
Vanguardbots
gracelindsell
No branches or pull requests
Part of #479. This issue is focused on the visual design of the API docs.
Right now, API docs are not using design elements to accurately reflect information hierarchy. For example, no colors or indentation.
This is an example class:
Some methods:
A standalone function, but note that it starts after the
Return type QasmQobj | PulseQobj
text:Compare to qiskit.org
These screenshots come from our repository for the Qiskit Sphinx Theme, the files starting with
api-docs-
: https://github.com/Qiskit/qiskit_sphinx_theme/tree/main/tests/js/tests.js-snapshotsA class with methods:
A module page showing a standalone function
The text was updated successfully, but these errors were encountered: