This repository has been archived by the owner on Aug 19, 2023. It is now read-only.
Redirect aer docs to new import path #1596
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
As part of the upcoming aer 0.11.0 release the project is moving to a separate package/namespace and will no longer be part of `qiskit.*`. This means the old documentation pages that existed for aer will no longer be built because autodoc for the path will no longer be from qiskit.providers.aer. To address this in the next metapackage release this commit adds redirects from the existing aer documentation pages to the new aer documentation. Related to Qiskit#1508
mtreinish
requested review from
jakelishman,
kevinhartman and
HuangJunye
as code owners
|
This is on hold until after aer 0.11.0 releases so the redirects have something to go to |
This was referenced Aug 31, 2022
To ease the migration of docs around the aer release this commit shifts the redirect from the old import path to the new import path in the same docs tree. This is needed for two reasons, while aer is still part of the metapackage we should document it as such, and secondly the current state of the Aer documentation isn't really for standalone hosting the docs aren't really sufficient on their own yet. So until both situations are resolved we should keep aer as part of the metapackage docs.
mtreinish
changed the title
|
I've updated this PR to keep aer as part of the metapackage, I explained the rationale in: Qiskit/qiskit@ac3169f for aer 0.12.0 we'll work on getting the standalone documentation in aer up to expectations. Then when aer isn't part of the metapackage anymore we'll be in a good place for updating the redirect to the standalone build |
jakelishman
approved these changes
Sep 2, 2022
jakelishman
approved these changes
Sep 15, 2022
mtreinish
added a commit
to mtreinish/qiskit
that referenced
this pull request
Sep 16, 2022
In Qiskit#1596 we added redirects from the old qiskit aer module paths to the new `qiskit_aer` path. However, that PR added the redirects relative to the root of the docs build and the sphinx-reredirects module does the redirects relative to the dir of the source path. This is causing the destination of the redirects to go to the wrong URL resulting in a 404. This commit updates the redirect configuration to ensure that the destination path is correct by treating the destination path relative to the source path which fixes the broken redirects.
mergify bot
pushed a commit
that referenced
this pull request
Sep 16, 2022
In #1596 we added redirects from the old qiskit aer module paths to the new `qiskit_aer` path. However, that PR added the redirects relative to the root of the docs build and the sphinx-reredirects module does the redirects relative to the dir of the source path. This is causing the destination of the redirects to go to the wrong URL resulting in a 404. This commit updates the redirect configuration to ensure that the destination path is correct by treating the destination path relative to the source path which fixes the broken redirects.
jakelishman
pushed a commit
to jakelishman/qiskit-terra
that referenced
this pull request
Aug 11, 2023
* Redirect aer docs to standalone aer page As part of the upcoming aer 0.11.0 release the project is moving to a separate package/namespace and will no longer be part of `qiskit.*`. This means the old documentation pages that existed for aer will no longer be built because autodoc for the path will no longer be from qiskit.providers.aer. To address this in the next metapackage release this commit adds redirects from the existing aer documentation pages to the new aer documentation. Related to Qiskit/qiskit-metapackage#1508 * Switch to redirect in docs tree To ease the migration of docs around the aer release this commit shifts the redirect from the old import path to the new import path in the same docs tree. This is needed for two reasons, while aer is still part of the metapackage we should document it as such, and secondly the current state of the Aer documentation isn't really for standalone hosting the docs aren't really sufficient on their own yet. So until both situations are resolved we should keep aer as part of the metapackage docs.
jakelishman
pushed a commit
to jakelishman/qiskit-terra
that referenced
this pull request
Aug 11, 2023
) In Qiskit/qiskit-metapackage#1596 we added redirects from the old qiskit aer module paths to the new `qiskit_aer` path. However, that PR added the redirects relative to the root of the docs build and the sphinx-reredirects module does the redirects relative to the dir of the source path. This is causing the destination of the redirects to go to the wrong URL resulting in a 404. This commit updates the redirect configuration to ensure that the destination path is correct by treating the destination path relative to the source path which fixes the broken redirects.
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
As part of the upcoming aer 0.11.0 release the project is moving to a
separate package/namespace and will no longer be part of
qiskit.*.This means the old documentation pages that existed for aer will no
longer be built because autodoc for the path will no longer be from
qiskit.providers.aer. To address this in the next metapackage release
this commit adds redirects from the existing aer documentation pages to
the new aer documentation.
Details and comments
Related to #1508