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

docs: update theme, improve consistency, rewrite user guide #72

Merged
merged 12 commits into from
Sep 28, 2023

Conversation

airwoodix
Copy link
Collaborator

@airwoodix airwoodix commented Sep 27, 2023

Summary

This patch is a overhaul of the documentation, with the following major changes:

  • switch the theme to qiskit-ecosystem from the newest qiskit-sphinx-theme package. This also triggered the switch to Sphinx 7 and a cleanup of the docs/ subtree.
  • improve internal and external linking in the API reference. Add API documentation for the transpiler plugin.
  • fully rewrite the user guide and add a quick start example in the documentation landing page. The new user guide goes a bit further than the previous one and puts emphasis on good practices and common quirks. A section about the specialized Sampler and Estimator primitives will be added later.

Details and comments

Closes #58.

The nitpicky flag for sphinx 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 for typing-extensions in the intersphinx_mapping doesn't allow resolving the few Self instances).

Use

poe docs
<browser> docs/_build/index.html

to preview the built docs.

Copy link
Collaborator

@alfrisch alfrisch left a 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!

docs/conf.py Outdated Show resolved Hide resolved
docs/guide.rst Outdated Show resolved Hide resolved
docs/guide.rst Outdated Show resolved Hide resolved
docs/guide.rst Outdated Show resolved Hide resolved
qiskit_aqt_provider/aqt_resource.py Outdated Show resolved Hide resolved
qiskit_aqt_provider/aqt_resource.py Show resolved Hide resolved
@airwoodix airwoodix added the documentation Improvements or additions to documentation label Sep 28, 2023
docs/guide.rst Outdated Show resolved Hide resolved
docs/guide.rst Outdated Show resolved Hide resolved
docs/guide.rst Outdated Show resolved Hide resolved
@airwoodix airwoodix merged commit 06bf787 into master Sep 28, 2023
4 checks passed
@airwoodix airwoodix deleted the use-qiskit-ecosystem-docs-theme branch September 28, 2023 15:41
Copy link
Contributor

@Eric-Arellano Eric-Arellano left a 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)

Comment on lines +40 to +41
html_theme = "qiskit-ecosystem"
pygments_style = "emacs"
Copy link
Contributor

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:

Suggested change
html_theme = "qiskit-ecosystem"
pygments_style = "emacs"
html_theme = "qiskit-ecosystem"
pygments_style = "emacs"
html_title = f"{project} {release}"

Copy link
Collaborator Author

@airwoodix airwoodix Sep 28, 2023

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants