Add docs publishing job #1589
Add docs publishing job #1589
Conversation
This commit adds a new CI job for publishing documentation on release. Now that qiskit-aer is a self contained package with it's own namespace the documentation build no longer needs to be combined into the main qiskit docs anymore. As such this commit will enable aer ci to publish built documentation for the project to: https://qiskit.org/documentation/aer on every release.
This commit adds the qiskit aer documentation to the other builds path. This will let qiskit-aer manage publishing its own documentation to https://qiskit.org/documentation/aer Starting in the pending 0.11.0 qiskit-aer release it has moved to its own python package/namespace qiskit_aer which will complicate the publishing the documentation under the same build as the qiskit main docs. So aer is moving to publishing it's own doc page in Qiskit/qiskit-aer#1589
|
If we're publishing it separately this time round, we probably need to run through the whole documentation adding intersphinx to Terra, and making sure the monkey-patched |
|
Well I was more concerned about how the main docs build will deal with the new namespace. I guess it would work fine and just build the pages as |
|
I'm mostly concerned with the things like I think the stubs that are generated by the Aer build itself should work, as you say. |
|
Happy to hold off on making changes to the documentation build process til later - we don't necessarily need to hold Aer 0.11 on that. |
This commit adds the qiskit aer documentation to the other builds path. This will let qiskit-aer manage publishing its own documentation to https://qiskit.org/documentation/aer Starting in the pending 0.11.0 qiskit-aer release it has moved to its own python package/namespace qiskit_aer which will complicate the publishing the documentation under the same build as the qiskit main docs. So aer is moving to publishing it's own doc page in Qiskit/qiskit-aer#1589
|
We need to change a branch protection rule from "docs (3.7)" to "docs (3.8)". |
Summary
This commit adds a new CI job for publishing documentation on release.
Now that qiskit-aer is a self contained package with it's own namespace
the documentation build no longer needs to be combined into the main
qiskit docs anymore. As such this commit will enable aer ci to publish
built documentation for the project to:
https://qiskit.org/documentation/aer
on every release.
Details and comments
Fixes Qiskit/qiskit#1508