Qiskit / qiskit-fermions
98%
main: 98%

LAST BUILD BRANCH: stable/0.2
DEFAULT BRANCH: main
Repo Added
Files 113
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

LAST BUILD ON BRANCH stable/0.2
branch: SELECT
CHANGE BRANCH
x

coverage: 97.966%. Remained the same
38424932262

push

github

web-flow 
More docs ToC updates (#377) (#378)

* 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.



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

This partially reverts #373

---------


(cherry picked from commit 713a1033e)

Co-authored-by: Max Rossmannek <21973473+mrossinek@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

12138 of 12390 relevant lines covered (97.97%)

526011.27 hits per line

Relevant lines Covered
12390 RELEVANT LINES 12138 COVERED LINES
526011.27 HITS PER LINE
Source Files on main

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
38424932262 stable/0.2 More docs ToC updates (#377) (#378) * 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 we... push web-flow github
97.97
38423366367 main 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 `:or... push web-flow github
98.01
38423405107 mergify/bp/stable/0.2/pr-377 Merge be2a43fd0 into 4d3999383 Pull #378 web-flow github
97.97
38421729166 more-docs-toc-updates Merge 25910d4c4 into 9099933b6 Pull #377 web-flow github
98.01
38419928650 more-docs-toc-updates Merge 8275be058 into 9099933b6 Pull #377 web-flow github
98.01
38372384293 stable/0.2 build(deps): bump pypa/cibuildwheel (#375) (#376) Bumps the github_actions group with 1 update: [pypa/cibuildwheel](https://github.com/pypa/cibuildwheel). Updates `pypa/cibuildwheel` from 4.2.1 to 4.3.0 - [Release notes](https://github.com/pypa/... push web-flow github
97.97
38370884246 main build(deps): bump pypa/cibuildwheel (#375) Bumps the github_actions group with 1 update: [pypa/cibuildwheel](https://github.com/pypa/cibuildwheel). Updates `pypa/cibuildwheel` from 4.2.1 to 4.3.0 - [Release notes](https://github.com/pypa/cibuil... push web-flow github
98.01
38370958101 mergify/bp/stable/0.2/pr-375 Merge 15cc40625 into 8223ff532 Pull #376 web-flow github
97.97
38001522367 dependabot/github_actions/github_actions-4667b7b1ab Merge 4ae92ca2a into f64fa34eb Pull #375 web-flow github
98.01
37632133477 stable/0.2 fix(docs): ensure the guides overview is included in the IQP ToC (#373) (#374) (cherry picked from commit f64fa34eb) Co-authored-by: Max Rossmannek <21973473+mrossinek@users.noreply.github.com> push web-flow github
97.97
See All Builds (764)