Update Sphinx theme #18
Conversation
docs/index.rst
Outdated
| @@ -13,6 +18,7 @@ parsing frameworks and so on is far more complex for code brought into Qiskit, | |||
| as the stability guarantees are much stronger. | |||
|
|
|||
| .. contents:: | |||
| :class: this-will-duplicate-information-and-it-is-still-useful-here | |||
There was a problem hiding this comment.
This line is used to avoid the warnings when using a ToC. This version of the Sphinx theme uses Furo and we get a warning using the contents directive when the right sidebar provides the same information already. To avoid this, you can delete the ToC or use :class: this-will-duplicate-information-and-it-is-still-useful-here.
Here you can see the issue pradyunsg/furo#88
There was a problem hiding this comment.
The discussion in that Furo issue suggests that the table of contents here isn't necessary any more. If you're trying to port this documentation to a new theme with different structural requirements, please can you make sure any requirements of the new theme are fully satisfied?
This ToC was originally added because Sphinx needs a top-level to define the structure, but it looks like you've added another one, which would render this obsolete.
There was a problem hiding this comment.
Yes, and I just double checked with @Eric-Arellano and I will delete that contents directive in the next commit. Thank you for the comment.
Summary
Updates to new Ecosystem theme.
For more information: Qiskit/qiskit_sphinx_theme#232