Qiskit / qiskit-fermions / 38423366367
98%

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

push

github

web-flow 
More docs ToC updates (#377)

* docs: link to IQP tutorial

* docs: link the API reference relatively from the toctree

The API-reference toctree entries pointed at absolute IBM Quantum
Platform URLs, and the Python and C API index pages were `:orphan:`.
The platform's addon ToC parser used to turn relative entries into
broken `/docs/addons/...` sections, so this was what the ingested
artifact needed. It cost every other consumer of the same build: the
GitHub Pages previews and local builds linked away from themselves,
and their API pages sat outside the toctree, so they rendered with the
prose sidebar and had no API ToC of their own. A post-build rewrite
script papered over the first problem and could not fix the second.

The platform now maps relative API-reference entries itself
(Qiskit/documentation#5771): `pydoc/` to `/docs/api/<pkg>`, `cdoc/` to
`/docs/api/<pkg>-c`, ignoring their sub-pages since the platform
builds the API ToC on its own, and release notes by href. So link
`pydoc/index` and `cdoc/index` relatively and put them back in the
toctree, which gives the API pages a working ToC in our own builds.
The larger sidebar this produces stays local: the platform only reads
the article body of each page, and the addon ToC from `index.html`.

With no self-links left in the artifact there is nothing to rewrite,
so remove `tools/rewrite_docs_links.py` together with its two callers,
the `docs-local` target and the publish-docs action's `rewrite-links`
step.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(docs): ensure we still redirect `guides/index.html`

This partially reverts #373

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

12232 of 12480 relevant lines covered (98.01%)

522217.92 hits per line

Jobs
ID Job ID Ran Files Coverage
1 38423366367.1 116
98.01
GitHub Action Run
Source Files on build 38423366367