-
Notifications
You must be signed in to change notification settings - Fork 21
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
docs: update theme, improve consistency, rewrite user guide #72
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the great docs improvement!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Huzzah!
(I didn't review the content changes, only the docs infra)
html_theme = "qiskit-ecosystem" | ||
pygments_style = "emacs" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes it so the left side bar doesn't include the word "documentation" in the site title:
html_theme = "qiskit-ecosystem" | |
pygments_style = "emacs" | |
html_theme = "qiskit-ecosystem" | |
pygments_style = "emacs" | |
html_title = f"{project} {release}" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the review!
Sorry, your review crossed the merge process. Could you please file a PR with your change?
Summary
This patch is a overhaul of the documentation, with the following major changes:
qiskit-ecosystem
from the newest qiskit-sphinx-theme package. This also triggered the switch to Sphinx 7 and a cleanup of thedocs/
subtree.Sampler
andEstimator
primitives will be added later.Details and comments
Closes #58.
The
nitpicky
flag forsphinx
is now enabled. Some of the registered exceptions could probably be solved, provided a significant time investment into the autodocs internals (it's not clear to me why adding an entry fortyping-extensions
in theintersphinx_mapping
doesn't allow resolving the fewSelf
instances).Use
to preview the built docs.