Aer needs its own documentation page #1508
Comments
|
Just for clarification that aer pr does not remove aer from the metapackage. It is creating a new python namespace. The term package there is in the strict python terminology which is confusing for most people: https://docs.python.org/3/glossary.html#term-package As for the issue this is kinda premature. Aer is still part of the metapackage for now. This issue is also primarily not something we fix in the metapackage repository as publishing self contained docs is done in the aer repository. |
|
I apologize "premature" probably wasn't the correct way to describe this. Upon reflection renaming the qiskit-aer package from |
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
|
I've pushed up Qiskit/qiskit-aer#1589, Qiskit/qiskit#1595, and Qiskit/qiskit#1596 which should address this. Aer will move to a standalone docs build and the main qiskit docs will have redirects from the old aer pages to the new build |
* 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 #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.
|
closed by Qiskit/qiskit-aer#1589 |
* 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.
With the removal of Aer from the metapackage, a documentation page for its own is needed.
Once Aer is removed from the metapackage, the module will be at the same level of other application modules and it will require its own https://qiskit.org/documentation/aer/ in the same way that https://qiskit.org/documentation/nature/ exists, for example.
I suggest creating https://qiskit.org/documentation/aer/ silently with no change in the metapackage documentation first.
The text was updated successfully, but these errors were encountered: