documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Published 20 hours ago • verified publisher icon Qiskit

API pipeline needs to add "front matter" (title / metadata) to several pages

Open Eric-Arellano opened this issue 10 months ago • 2 comments

These never had front matter. Axel said it's fine for now, but we should improve it soon.

Please fix these files: docs/api/qiskit-ibm-provider/ibm-provider.md,docs/api/qiskit/transpiler_builtin_plugins.md,docs/api/qiskit-ibm-runtime/ibm-runtime.md

We need to an else clause here:

https://github.com/Qiskit/documentation/blob/e8724413bfa5d8885f4efa308ce44efe140440bf/scripts/lib/sphinx/addFrontMatter.ts#L19-L30

TBD how we determine the title and description!

Update: make sure CI enforces it, per https://github.com/Qiskit/documentation/issues/793.

Eric-Arellano avatar Oct 02 '23 13:10 Eric-Arellano