Qiskit / qiskit-addon-sqd / 38992964312
91%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 7
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: 82.101%. Remained the same
38992964312

push

github

web-flow 
Fix unresolved cross-references found by Sphinx nitpicky mode (#406)

Building the docs with nitpicky = True turns up eight unresolved
references in three groups.  None of them fail the build today, since
nitpicky is off, but each one is a link that silently renders as plain
text instead.

Add an API reference page for qiskit_addon_sqd.processes.  The module is
public and its concepts are described in the HPC acceleration guide, but
it had no page, so the references to processes.broadcast and
processes.barrier in the fermion docstrings had nothing to resolve to.
This is the one substantive gap of the three: the module's documentation
was simply not being built.

Add scipy to intersphinx_mapping.  project_operator_to_subspace is
annotated as returning spmatrix, which could not resolve without it.
scipy's inventory carries scipy.sparse._matrix.spmatrix as an alias, so
the return type now links to the public spmatrix page.

Drop the :func: role from two release notes that name functions which no
longer exist: flip_orbital_occupancies, removed in 0.10, and
bitstring_matrix_to_sorted_addresses, deprecated in 0.6 and since
removed.  The notes are historically accurate and their wording is
unchanged; only the two dead names become literals.  Cross-references to
functions that do still exist are left alone.

nitpicky is deliberately not enabled here.  155 references in these docs
resolve only through a remote inventory -- 142 of them through numpy,
which supplies every np.ndarray annotation -- so a reorganized upstream
docs URL would turn into 142 CI errors on a commit that changed nothing.
The protection it would add is also mostly redundant: because the build
runs with -W, an unreachable inventory already fails CI with a single
clear warning, which is easier to read than the pile of "target not
found" errors nitpicky would produce from the same cause.  It remains
useful as an occasional local audit, which is how these were found.

Assisted-by: Claude Opus 5

633 of 771 relevant lines covered (82.1%)

0.82 hits per line

Jobs
ID Job ID Ran Files Coverage
1 38992964312.1 7
82.1
GitHub Action Run
Source Files on build 38992964312