Remove unneeded Sphinx templates and static files #9712
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
These files are several files left over from old versions of the documentation, and several from before `qiskit-sphinx-theme` was entirely separate from the Terra docs-build process. Having them remain in the repository causes local (or CI) builds of the documentation to pull from these templates instead of those provided by the theme package, which causes us to get different behaviour to what will actually be deployed during the metapackage docs build.
jakelishman
added
documentation
|
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 4323873994
💛 - Coveralls |
mtreinish
approved these changes
Mar 3, 2023
There was a problem hiding this comment.
This makes sense to me these templates are locally overriding things for no reason, we should keep in sync with the theme layout for these builds. At some point this will get more important when there is a unified docs build here without a metapackage and the terra docs builds are what get published.
Eric-Arellano
approved these changes
Mar 3, 2023
There was a problem hiding this comment.
Excellent, thank you! cc @javabster - perhaps this explains some docs behavior?
mergify bot
pushed a commit
that referenced
this pull request
Mar 3, 2023
These files are several files left over from old versions of the documentation, and several from before `qiskit-sphinx-theme` was entirely separate from the Terra docs-build process. Having them remain in the repository causes local (or CI) builds of the documentation to pull from these templates instead of those provided by the theme package, which causes us to get different behaviour to what will actually be deployed during the metapackage docs build. Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit 40f73a3)
mergify bot
added a commit
that referenced
this pull request
Mar 3, 2023
These files are several files left over from old versions of the documentation, and several from before `qiskit-sphinx-theme` was entirely separate from the Terra docs-build process. Having them remain in the repository causes local (or CI) builds of the documentation to pull from these templates instead of those provided by the theme package, which causes us to get different behaviour to what will actually be deployed during the metapackage docs build. Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit 40f73a3) Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
king-p3nguin
pushed a commit
to king-p3nguin/qiskit-terra
that referenced
this pull request
May 22, 2023
These files are several files left over from old versions of the documentation, and several from before `qiskit-sphinx-theme` was entirely separate from the Terra docs-build process. Having them remain in the repository causes local (or CI) builds of the documentation to pull from these templates instead of those provided by the theme package, which causes us to get different behaviour to what will actually be deployed during the metapackage docs build. Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
These files are several files left over from old versions of the documentation, and several from before
qiskit-sphinx-themewas entirely separate from the Terra docs-build process. Having them remain in the repository causes local (or CI) builds of the documentation to pull from these templates instead of those provided by the theme package, which causes us to get different behaviour to what will actually be deployed during the metapackage docs build.Details and comments
Found during the process of writing the bugfix Qiskit/qiskit_sphinx_theme#197. Other Qiskit projects may well want to copy the spirit of this PR if they haven't already, in particular ensuring that they're not providing a
layout.htmltemplate that overrides the up-to-date, unified one provided byqiskit_sphinx_theme(though likely everyone will want to get rid of everything intemplatesexcept for theirautosummarysettings).