Use new Furo theme #1225
Use new Furo theme #1225
Conversation
this needs to be addressed later
| @@ -16,7 +16,6 @@ | |||
|
|
|||
| import os | |||
| import sys | |||
| import subprocess | |||
There was a problem hiding this comment.
This was an unused import.
| .. toctree:: | ||
| :hidden: | ||
|
|
||
| Qiskit Experiments Home <self> | ||
| Getting Started <tutorials/getting_started> |
There was a problem hiding this comment.
Adding Getting Started as a separate menu item to follow the recommended site structure: https://github.com/Qiskit/qiskit_sphinx_theme#tip-suggested-site-structure
|
|
| @@ -0,0 +1,31 @@ | |||
| .nbsphinx-gallery { | |||
There was a problem hiding this comment.
Maybe add a comment explaining what's going on. Or even better, open a GitHub issue and link to it.
There was a problem hiding this comment.
I have a comment here: https://github.com/Qiskit-Extensions/qiskit-experiments/blob/2ba6109e11fc086855d8360ad173a04f094dc7d4/docs/conf.py#L80
I can write an issue too.
| Curve Analysis <tutorials/curve_analysis> | ||
| Visualization <tutorials/visualization> | ||
| Custom Experiments <tutorials/custom_experiment> | ||
|
|
||
| .. toctree:: | ||
| :hidden: |
There was a problem hiding this comment.
Should this be hidden? Another option is to set :maxdepth: 1 or 2.
There was a problem hiding this comment.
I think it's supposed to be hidden or the entire ToC gets rendered after the page contents:
This toctree is only used to register those links for the sidebar.
Summary
This PR switches the docs to the new Furo ecosystem theme.
Details and comments
New build variables have been added:
FULL_TOCTREEbuilds the full API toctree when turned on. By default, this is off for a fast build time and small file sizes. This is turned on for deployments. See Furo: investigate slow builds Qiskit/qiskit_sphinx_theme#328 for more info.VERSION_STRINGandRELEASE_STRINGare exposed so that the site can display an alternative version/release for builds. This is relevant for the dev site, where we would like to see thegit describecommit string instead of the version to be clearer to users. The new theme currently does not expose the version/release (except for the release in the page title) since it doesn't have breadcrumbs, but this will be added after Furo: Add breadcrumb menu Qiskit/qiskit_sphinx_theme#361.Current known issues:
The experiment gallery doesn't render correctly by default, so the CSS is inserted manually via
_static/nbsphinx-gallery.css.