Qiskit-Extensions / circuit-knitting-toolbox

Tools for knitting quantum circuits with Qiskit
https://qiskit-extensions.github.io/circuit-knitting-toolbox/
Apache License 2.0
70 stars 24 forks source link

RFC: Re-execute notebooks on CI when building Sphinx docs #534

Closed garrison closed 2 months ago

garrison commented 3 months ago

Currently, we have set nbsphinx_execute = "auto" in the Sphinx configuration so that notebooks are not re-executed anytime someone runs tox -e docs, in large part to speed up the build cycle for quick development.

However, even without changing this for local builds, we have the option of changing this on CI, which is where our deployed documentation is built.

Here's what would be different:

I'm not really sure which I'd prefer, but think it is worth considering merging this. Open to discussion.

coveralls commented 3 months ago

Pull Request Test Coverage Report for Build 8572354280

Details


Totals Coverage Status
Change from base Build 8560627750: 0.0%
Covered Lines: 3448
Relevant Lines: 3613

💛 - Coveralls
caleb-johnson commented 2 months ago

I am highly in favor of adding this. Didn't realize this was straightforward