Skip to content

Commit

Permalink
Redirect aer docs to new import path (Qiskit/qiskit-metapackage#1596)
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
mtreinish authored Sep 15, 2022
1 parent 91b0df0 commit 2a7b21b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,11 @@
for tutorial in experiments_tutorials:
redirects["tutorials/noise/%s" % tutorial] = "https://qiskit.org/documentation/experiments/tutorials/index.html"

with open("aer_sources.txt", "r") as fd:
for source_str in fd:
target_str = source_str.replace("qiskit.providers.aer", "qiskit_aer")
redirects[source_str] = target_str

nbsphinx_timeout = 300
nbsphinx_execute = os.getenv('QISKIT_DOCS_BUILD_TUTORIALS', 'never')
nbsphinx_widgets_path = ''
Expand Down

0 comments on commit 2a7b21b

Please sign in to comment.