This repository has been archived by the owner on Aug 19, 2023. It is now read-only.
Change deprecated sphinx-panels to sphinx-design #1558
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`sphinx-panels` is unmaintained, and suggests `sphinx-design` as a largely drop-in replacement. For our uses (only within Terra), we need nothing more than to just change the dependency. `sphinx-panels` was previously pinning us to Sphinx < 5, transitively. With the new version of Sphinx, setting `language = None` is deprecated; English is no longer implied by `None`, we have to set it (since, you know, there are other languages in the world...).
jakelishman
requested review from
mtreinish,
kevinhartman,
HuangJunye and
y4izus
as code owners
mtreinish
approved these changes
Jun 27, 2022
mtreinish
added a commit
to mtreinish/qiskit
that referenced
this pull request
Jul 14, 2022
In Qiskit#1558 the sphinx plugin sphinx-panel was switched to sphinx-design to enable building the documentation with sphinx >=5.0.0. However, while the build succeeded there were warnings emitted about tabbed directive which was only valid for sphinx-panel. This prevented any tabbed sections in the documentation from being built as sphinx just ignored it (this is why it's best practice to build with -W to make warnings fatal because they're almost always pointing to broken docs). This commit fixes this by migrating the directives to use the syntax from sphinx-design so that we're building the tabs sections of the documentation.
mtreinish
added a commit
to mtreinish/qiskit
that referenced
this pull request
Jul 14, 2022
In Qiskit#1558 the sphinx plugin sphinx-panel was switched to sphinx-design to enable building the documentation with sphinx >=5.0.0. However, while the build succeeded there were warnings emitted about tabbed directive which was only valid for sphinx-panel. This prevented any tabbed sections in the documentation from being built as sphinx just ignored it (this is why it's best practice to build with -W to make warnings fatal because they're almost always pointing to broken docs). This commit fixes this by migrating the directives to use the syntax from sphinx-design so that we're building the tabs sections of the documentation. Fixes Qiskit#1566
mergify bot
pushed a commit
that referenced
this pull request
Jul 14, 2022
In #1558 the sphinx plugin sphinx-panel was switched to sphinx-design to enable building the documentation with sphinx >=5.0.0. However, while the build succeeded there were warnings emitted about tabbed directive which was only valid for sphinx-panel. This prevented any tabbed sections in the documentation from being built as sphinx just ignored it (this is why it's best practice to build with -W to make warnings fatal because they're almost always pointing to broken docs). This commit fixes this by migrating the directives to use the syntax from sphinx-design so that we're building the tabs sections of the documentation. Fixes #1566
jakelishman
added a commit
to jakelishman/qiskit-terra
that referenced
this pull request
Aug 11, 2023
…ackage#1558) `sphinx-panels` is unmaintained, and suggests `sphinx-design` as a largely drop-in replacement. For our uses (only within Terra), we need nothing more than to just change the dependency. `sphinx-panels` was previously pinning us to Sphinx < 5, transitively. With the new version of Sphinx, setting `language = None` is deprecated; English is no longer implied by `None`, we have to set it (since, you know, there are other languages in the world...).
jakelishman
pushed a commit
to jakelishman/qiskit-terra
that referenced
this pull request
Aug 11, 2023
In Qiskit/qiskit-metapackage#1558 the sphinx plugin sphinx-panel was switched to sphinx-design to enable building the documentation with sphinx >=5.0.0. However, while the build succeeded there were warnings emitted about tabbed directive which was only valid for sphinx-panel. This prevented any tabbed sections in the documentation from being built as sphinx just ignored it (this is why it's best practice to build with -W to make warnings fatal because they're almost always pointing to broken docs). This commit fixes this by migrating the directives to use the syntax from sphinx-design so that we're building the tabs sections of the documentation. Fixes Qiskit/qiskit-metapackage#1566
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
sphinx-panelsis unmaintained, and suggestssphinx-designas alargely drop-in replacement. For our uses (only within Terra), we need
nothing more than to just change the dependency.
sphinx-panelswas previously pinning us to Sphinx < 5, transitively.With the new version of Sphinx, setting
language = Noneis deprecated;English is no longer implied by
None, we have to set it (since, youknow, there are other languages in the world...).
Details and comments
See also Qiskit/qiskit#8242, Qiskit/qiskit-aer#1548.