Qiskit / qiskit-addon-aqc-tensor / 27842114000
100%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 13
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 100.0%. Remained the same
27842114000

push

github

web-flow 
Test docstring code examples with the Sphinx doctest builder (#93)

* Enable doctest

Currently a draft since tests fail.

Closes #88.

* Use Sphinx doctest builder to test docstring code examples

pytest-doctestplus only executes `>>>`-prefixed doctests; it does not
run bare `.. code-block:: python` directives, which is what our
docstring examples use. As a result, `pytest --doctest-plus
--doctest-rst docs/` collected zero items and `tox -e doctest` exited 5.

Switch to Sphinx's own doctest builder instead:

- Enable `sphinx.ext.doctest`.
- Convert the two `.. code-block:: python` examples (QiskitAerSimulationSettings
  and QuimbSimulator) to `.. testcode::`. This renders identically in the
  built docs but is executed by `sphinx-build -b doctest`.
- Point the `doctest` tox env at the doctest builder, using the same
  `docs` + `notebook-dependencies` extras as the `docs` env so that the
  Sphinx machinery (plot_directive) and the example imports (qiskit-aer,
  quimb, jax) are all available.

The `.. plot::` ansatz examples are already executed at docs-build time
by matplotlib's plot_directive, so they need no change.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* ci: install pandoc for the doctest job

The `doctest` tox env now runs the Sphinx doctest builder, which goes
through nbsphinx to process the notebook-based tutorials. nbsphinx
requires pandoc, so the test workflow failed with `PandocMissing`.

Add `r-lib/actions/setup-pandoc` (cross-platform, covers the
ubuntu/macos/windows matrix) before installing tox. Mirrors the
existing pandoc install in the docs workflow, but uses the action
instead of `apt-get` since this job also runs on macOS and Windows.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* ci: fetch full git history for the doctest job

The `doctest` env runs a full Sphinx build, which includes reno's
release-notes page. reno scans the git history (via dulwich) to group
notes by versio... (continued)

669 of 669 relevant lines covered (100.0%)

1.0 hits per line

Jobs
ID Job ID Ran Files Coverage
1 27842114000.1 13
100.0
 GitHub Action Run
Source Files on build 27842114000