-
Notifications
You must be signed in to change notification settings - Fork 127
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update docstring options parser and add docs cron job #1312
Update docstring options parser and add docs cron job #1312
Conversation
@@ -1,3 +1,4 @@ | |||
qiskit-terra>=0.45.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pinned the version here since the iqp
style was renamed in 0.45.0.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me. It should be backported so we can build the docs on 0.5 if needed, but maybe we are hoping not to need another 0.5 release?
Also, should we build the docs in the cron run to catch changes like this? |
@wshanks Yes, I'm hoping to not do another 0.5 release. The docs cron job is a good idea—added to this PR. |
.github/workflows/cron-staging.yml
Outdated
sudo apt-get install -y pandoc graphviz | ||
- name: Build Docs | ||
run: tox -edocs-parallel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will catch a problem the day after a new release (of anything) breaks something. Is that good enough or should run against terra main like we do with the tests so we can catch problems before release?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My bad, thanks for catching. I've added a docs-terra-main
environment now. tox.ini
keeps getting more bloated, which I hope can be addressed by switching to another tool.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it is hard to prioritize everything. We could review nox and hatch again. One option might be to stick with tox and to use a separate task running tool like make or just to define commands to run. I think we only need two tox environments (terra release and terra main) and its just different commands that we need to run. With tox exec
, we can run different commands in the same tox environment rather than defining a separate environment for each command and using tox run
.
Qiskit 0.45 introduces singleton gates, which have dynamically generated type objects, so their associated module have to be accessed from the `base_class` attribute. This PR update the docstring options parser to work correctly with these objects. It also specifies the `iqp` style when drawing circuits to avoid deprecation warnings during the build, and adds the docs build to the daily cron job so this kind of issue can be caught more quickly in the future. Because Aer 0.13.0 is causing a slowdown in docs builds, this PR also temporarily pins the version to 0.12.2 until the next patch release. (cherry picked from commit f16be3b) # Conflicts: # .github/workflows/cron-staging.yml # docs/tutorials/calibrations.rst # requirements-extras.txt # tox.ini
…ty#1312) Qiskit 0.45 introduces singleton gates, which have dynamically generated type objects, so their associated module have to be accessed from the `base_class` attribute. This PR update the docstring options parser to work correctly with these objects. It also specifies the `iqp` style when drawing circuits to avoid deprecation warnings during the build, and adds the docs build to the daily cron job so this kind of issue can be caught more quickly in the future. Because Aer 0.13.0 is causing a slowdown in docs builds, this PR also temporarily pins the version to 0.12.2 until the next patch release.
Qiskit 0.45 introduces singleton gates, which have dynamically generated type objects, so their associated module have to be accessed from the
base_class
attribute. This PR update the docstring options parser to work correctly with these objects. It also specifies theiqp
style when drawing circuits to avoid deprecation warnings during the build, and adds the docs build to the daily cron job so this kind of issue can be caught more quickly in the future.Because Aer 0.13.0 is causing a slowdown in docs builds, this PR also temporarily pins the version to 0.12.2 until the next patch release.