Qiskit / qiskit-fermions / 40855189934
98%

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

push

github

web-flow 
docs: generate `llms.txt` summaries and serve `.md` variants of subpages (#408)

* feat(docs): generate llms.txt and per-page Markdown for the Pages previews

The previews on GitHub Pages (dev/ and stable/X.Y/) get no llms.txt from
the IBM Quantum Platform, which only injects its own for the released
docs. Adding sphinx-llm gives agents an index plus a Markdown copy of
every page next to its HTML.

The Markdown sub-build needed a few adjustments to be usable:

- Image URIs are rewritten to the copies the HTML build puts in
  _images/. As emitted they are relative to the source root and resolved
  to nothing from the page containing them.
- RST comments are dropped. The description scraper only skips the first
  line of the resulting HTML comment, so a multi-line one (as on the
  guides overview) became that page's description.
- The "Bases: ..." line autodoc puts first in every class entry is moved
  behind the first prose paragraph. Otherwise it was the description of
  every class page.
- Only the unknown node types we actually hit are exempt from warnings,
  so -W still fails on a new one rather than silencing all of them.

Only the .html.md form is written, since the default also emitted a
redundant .md copy of every page. llms-full.txt stays off.

The root of the Pages site gets an llms.txt that links to the llms.txt
of dev/ and each stable/X.Y/ build. It is derived from the filesystem
like the landing page, so it runs inside the existing push-retry loop
with no workflow change. A release branch is listed only once its own
build has an llms.txt, which skips every branch that predates this.
Pull-request previews are left out on purpose.

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

* fix(docs): close stray figures

* docs: describe landing, guide and module pages for llms.txt

Each llms.txt entry carries a one-line description. Without an override
it is scraped from the first paragraph of the page, which is often an
introductory sent... (continued)

14343 of 14602 relevant lines covered (98.23%)

447619.18 hits per line

Jobs
ID Job ID Ran Files Coverage
1 40855189934.1 131
98.23
GitHub Action Run
Source Files on build 40855189934