[Stable] Migrate documentation and benchmarks from metapackage (#10611) #10632
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
This cross-repository merge unifies the documentation, benchmarks and code of conduct from the metapackage into Qiskit/Terra's build.
There are very non-trivial merge conflicts that have been resolved by this commit. The summary is:
CODE_OF_CONDUCT.md: taken directly from the metapackage's version.docs/conf.py: strongly unified, albeit without the translations components that are added in a separate commit.docs/index.rst: taken almost verbatim from the metapackage. All the API documentation RST files on Terra are moved todocs/apidoc(without the trailing 's') to match the metapackage expectation, so the URLs of built documentation will not change.docs/release_notes.rst: The metapackage's version is renamed todocs/legacy_release_notes.rst, given a small introductory header, and made an orphan linked only from a newdocs/release_notes.rstthat usesreno.docs/tutorials.rst: Mostly these were the same already. Updated to include Qiskit/Terra's correction that it's not an orphan, and contain the metapackage's extra intro tutorial.docs/apidoc/terra.rst: renamed todocs/apidoc/index.rstand retitled to be correctly just "API Documentation".requirements-dev.txt: the version of the Sphinx theme is bumped to 1.14 to match the metapackage expectation.Following merge commit ec5c9ca, there is a commit 66a5d9f that fixes the ASV build for use in Terra, which is the rollup of the post-merge commits of #10546, which this PR supersedes.
This should probably be merged ASAP before
mainmoves on.Resolutions on the metapackage:
qiskit/qiskit-metapackagetoqiskit/qiskit-terraqiskit-metapackage#1722After this has merged, #10610 should merge which will close the remaining migration-related issues from the metapackage.
The metapackage was prepared for the migration using
git-filter-repo, with the scripts and configuration files contained withinmetapackage_migration.zip. If you extract that zip, you need to activate a Python 3.11
venvthen runmetapackage_rewrite.bashwhich will prepare the repo in the exact state I merged to create this PR.edit: In retrospect writing this, you might need to modify my script so that it pulls only starting from commit
Qiskit/qiskit-metapackage@f131daf, which was the tip of
masterat the time I ran this.I tested the docs build locally and it looks as correct as I can tell. There's still big cards pointing to experiments, dynamics etc on the landing page, but I figured that enough's enough, and we can just fix those last two things in Terra. This PR does not include Qiskit/qiskit-metapackage#1791, which should be now cherry-picked onto Terra.
Details and comments
(cherry picked from commit 965fd23)
Backported from #10611
This commit is a squashed version of the merge commit from #10611. For the stable branch we don't need to preserve the full commit history like we did on the
mainbranch. The contents of the PR branch here match the diff of #10611 but doesn't include the full 250 commits as it's a squashed cherry-pick of the merge commit. This was done manually because the mergify bot is unable to cherry-pick a merge commit. A merge commit was used for the PR to main to preserve the full commit history for the migration from qiskit-metapackage.The one merge conflict was the because
docs/apidoc/passmanager.rstwhich doesn't exist on the stable branch.