search

Qiskit / documentation

The documentation content home for https://docs.quantum.ibm.com.
https://docs.quantum.ibm.com
Apache License 2.0
37 stars 60 forks source link

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

Open Eric-Arellano opened 11 months ago

Eric-Arellano commented 11 months ago

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.

axelhzf commented 9 months ago

Perhaps we can use the filename as a fallback?

Eric-Arellano commented 7 months ago

https://github.com/Qiskit/documentation/pull/821 fixes a legit bug in historical API docs. The other files so far seem to be because they are not using the automodule directive. Instead, they're pages like

https://github.com/Qiskit/qiskit/blob/1e0e4fccd469617489a28e4cfa38271a9b0b617b/docs/apidoc/transpiler_builtin_plugins.rst?plain=1#L1-L10

I'm thinking we could extract the title from the <h1>, like Built-in Transpiler Synthesis Plugins. Then the description could be API docs for Built-in Transpiler Synthesis Plugins.

We should go through this file list to confirm that this is the correct diagnosis and fix:

Failing files after #821

docs/api/qiskit/transpiler_builtin_plugins.md docs/api/qiskit/0.19/aer.md docs/api/qiskit/0.19/ibmq_jupyter.md docs/api/qiskit/0.19/ibmq_visualization.md docs/api/qiskit/0.19/qiskit.aqua.aqua_globals.md docs/api/qiskit/0.19/qiskit.optimization.INFINITY.md docs/api/qiskit/0.19/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.24/aer.md docs/api/qiskit/0.24/aqua.md docs/api/qiskit/0.24/ibmq-provider.md docs/api/qiskit/0.24/ibmq_jupyter.md docs/api/qiskit/0.24/ibmq_visualization.md docs/api/qiskit/0.24/qiskit.aqua.aqua_globals.md docs/api/qiskit/0.24/qiskit.optimization.INFINITY.md docs/api/qiskit/0.24/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.25/aer.md docs/api/qiskit/0.25/aqua.md docs/api/qiskit/0.25/ibmq-provider.md docs/api/qiskit/0.25/ibmq_jupyter.md docs/api/qiskit/0.25/ibmq_visualization.md docs/api/qiskit/0.25/qiskit.aqua.aqua_globals.md docs/api/qiskit/0.25/qiskit.optimization.INFINITY.md docs/api/qiskit/0.25/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.25/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.26/aer.md docs/api/qiskit/0.26/aqua.md docs/api/qiskit/0.26/ibmq-provider.md docs/api/qiskit/0.26/ibmq_jupyter.md docs/api/qiskit/0.26/ibmq_visualization.md docs/api/qiskit/0.26/qiskit.aqua.aqua_globals.md docs/api/qiskit/0.26/qiskit.optimization.INFINITY.md docs/api/qiskit/0.26/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.26/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.27/aer.md docs/api/qiskit/0.27/aqua.md docs/api/qiskit/0.27/ibmq-provider.md docs/api/qiskit/0.27/ibmq_jupyter.md docs/api/qiskit/0.27/ibmq_visualization.md docs/api/qiskit/0.27/qiskit.aqua.aqua_globals.md docs/api/qiskit/0.27/qiskit.optimization.INFINITY.md docs/api/qiskit/0.27/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.27/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.30/aer.md docs/api/qiskit/0.30/aqua.md docs/api/qiskit/0.30/ibmq-provider.md docs/api/qiskit/0.30/ibmq_jupyter.md docs/api/qiskit/0.30/ibmq_visualization.md docs/api/qiskit/0.30/parallel.md docs/api/qiskit/0.30/qiskit.aqua.aqua_globals.md docs/api/qiskit/0.30/qiskit.optimization.INFINITY.md docs/api/qiskit/0.30/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.30/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.29/aer.md docs/api/qiskit/0.29/aqua.md docs/api/qiskit/0.29/ibmq-provider.md docs/api/qiskit/0.29/ibmq_jupyter.md docs/api/qiskit/0.29/ibmq_visualization.md docs/api/qiskit/0.29/qiskit.aqua.aqua_globals.md docs/api/qiskit/0.29/qiskit.optimization.INFINITY.md docs/api/qiskit/0.29/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.29/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.31/aer.md docs/api/qiskit/0.31/aqua.md docs/api/qiskit/0.31/ibmq-provider.md docs/api/qiskit/0.31/ibmq_jupyter.md docs/api/qiskit/0.31/ibmq_visualization.md docs/api/qiskit/0.31/parallel.md docs/api/qiskit/0.31/qiskit.aqua.aqua_globals.md docs/api/qiskit/0.31/qiskit.optimization.INFINITY.md docs/api/qiskit/0.31/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.31/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.28/aer.md docs/api/qiskit/0.28/aqua.md docs/api/qiskit/0.28/ibmq-provider.md docs/api/qiskit/0.28/ibmq_jupyter.md docs/api/qiskit/0.28/ibmq_visualization.md docs/api/qiskit/0.28/qiskit.aqua.aqua_globals.md docs/api/qiskit/0.28/qiskit.optimization.INFINITY.md docs/api/qiskit/0.28/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.28/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.32/aer.md docs/api/qiskit/0.32/aqua.md docs/api/qiskit/0.32/ibmq-provider.md docs/api/qiskit/0.32/ibmq_jupyter.md docs/api/qiskit/0.32/ibmq_visualization.md docs/api/qiskit/0.32/parallel.md docs/api/qiskit/0.32/qiskit.aqua.aqua_globals.md docs/api/qiskit/0.32/qiskit.optimization.INFINITY.md docs/api/qiskit/0.32/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.32/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.35/aer.md docs/api/qiskit/0.35/ibmq-provider.md docs/api/qiskit/0.35/ibmq_jupyter.md docs/api/qiskit/0.35/ibmq_visualization.md docs/api/qiskit/0.35/parallel.md docs/api/qiskit/0.35/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.35/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.35/transpiler_builtin_plugins.md docs/api/qiskit/0.33/aer.md docs/api/qiskit/0.33/ibmq-provider.md docs/api/qiskit/0.33/ibmq_jupyter.md docs/api/qiskit/0.33/ibmq_visualization.md docs/api/qiskit/0.33/parallel.md docs/api/qiskit/0.33/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.33/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.33/transpiler_builtin_plugins.md docs/api/qiskit/0.36/aer.md docs/api/qiskit/0.36/ibmq-provider.md docs/api/qiskit/0.36/ibmq_jupyter.md docs/api/qiskit/0.36/ibmq_visualization.md docs/api/qiskit/0.36/parallel.md docs/api/qiskit/0.36/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.36/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.36/transpiler_builtin_plugins.md docs/api/qiskit/0.37/aer.md docs/api/qiskit/0.37/ibmq-provider.md docs/api/qiskit/0.37/ibmq_jupyter.md docs/api/qiskit/0.37/ibmq_visualization.md docs/api/qiskit/0.37/parallel.md docs/api/qiskit/0.37/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.37/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.37/transpiler_builtin_plugins.md docs/api/qiskit/0.38/aer.md docs/api/qiskit/0.38/ibmq-provider.md docs/api/qiskit/0.38/ibmq_jupyter.md docs/api/qiskit/0.38/ibmq_visualization.md docs/api/qiskit/0.38/parallel.md docs/api/qiskit/0.38/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.38/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.38/transpiler_builtin_plugins.md docs/api/qiskit/0.39/aer.md docs/api/qiskit/0.39/ibmq-provider.md docs/api/qiskit/0.39/ibmq_jupyter.md docs/api/qiskit/0.39/ibmq_visualization.md docs/api/qiskit/0.39/parallel.md docs/api/qiskit/0.39/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.39/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.39/transpiler_builtin_plugins.md docs/api/qiskit/0.40/aer.md docs/api/qiskit/0.40/ibmq-provider.md docs/api/qiskit/0.40/ibmq_jupyter.md docs/api/qiskit/0.40/ibmq_visualization.md docs/api/qiskit/0.40/parallel.md docs/api/qiskit/0.40/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.40/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.40/transpiler_builtin_plugins.md docs/api/qiskit/0.42/aer.md docs/api/qiskit/0.42/ibmq-provider.md docs/api/qiskit/0.42/ibmq_jupyter.md docs/api/qiskit/0.42/ibmq_visualization.md docs/api/qiskit/0.42/parallel.md docs/api/qiskit/0.42/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.42/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.42/transpiler_builtin_plugins.md docs/api/qiskit/0.43/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.43/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.43/transpiler_builtin_plugins.md docs/api/qiskit/0.44/transpiler_builtin_plugins.md docs/api/qiskit/0.41/aer.md docs/api/qiskit/0.41/ibmq-provider.md docs/api/qiskit/0.41/ibmq_jupyter.md docs/api/qiskit/0.41/ibmq_visualization.md docs/api/qiskit/0.41/parallel.md docs/api/qiskit/0.41/qiskit.quantum_info.two_qubit_cnot_decompose.md docs/api/qiskit/0.41/qiskit.utils.algorithm_globals.md docs/api/qiskit/0.41/transpiler_builtin_plugins.md docs/api/qiskit/0.45/transpiler_builtin_plugins.md docs/api/qiskit/dev/transpiler_builtin_plugins.md

Eric-Arellano commented 1 week ago

https://github.com/Qiskit/documentation/pull/1917 fixed a lot of violations. The remaining failures should be fixed in specialCaseResults.tsx. Make sure checkOrphanPages.tsx can also be fixed.

failures docs/api/qiskit/0.19/aer.mdx docs/api/qiskit/0.19/ibmq_jupyter.mdx docs/api/qiskit/0.19/ibmq_visualization.mdx docs/api/qiskit/0.24/aer.mdx docs/api/qiskit/0.24/aqua.mdx docs/api/qiskit/0.24/ibmq-provider.mdx docs/api/qiskit/0.24/ibmq_jupyter.mdx docs/api/qiskit/0.24/ibmq_visualization.mdx docs/api/qiskit/0.25/aer.mdx docs/api/qiskit/0.25/aqua.mdx docs/api/qiskit/0.25/ibmq-provider.mdx docs/api/qiskit/0.25/ibmq_jupyter.mdx docs/api/qiskit/0.25/ibmq_visualization.mdx docs/api/qiskit/0.26/aer.mdx docs/api/qiskit/0.26/aqua.mdx docs/api/qiskit/0.26/ibmq-provider.mdx docs/api/qiskit/0.26/ibmq_jupyter.mdx docs/api/qiskit/0.26/ibmq_visualization.mdx docs/api/qiskit/0.27/aer.mdx docs/api/qiskit/0.27/aqua.mdx docs/api/qiskit/0.27/ibmq-provider.mdx docs/api/qiskit/0.27/ibmq_jupyter.mdx docs/api/qiskit/0.27/ibmq_visualization.mdx docs/api/qiskit/0.28/aer.mdx docs/api/qiskit/0.28/aqua.mdx docs/api/qiskit/0.28/ibmq-provider.mdx docs/api/qiskit/0.28/ibmq_jupyter.mdx docs/api/qiskit/0.28/ibmq_visualization.mdx docs/api/qiskit/0.29/aer.mdx docs/api/qiskit/0.29/aqua.mdx docs/api/qiskit/0.29/ibmq-provider.mdx docs/api/qiskit/0.29/ibmq_jupyter.mdx docs/api/qiskit/0.29/ibmq_visualization.mdx docs/api/qiskit/0.30/aer.mdx docs/api/qiskit/0.30/aqua.mdx docs/api/qiskit/0.30/ibmq-provider.mdx docs/api/qiskit/0.30/ibmq_jupyter.mdx docs/api/qiskit/0.30/ibmq_visualization.mdx docs/api/qiskit/0.30/parallel.mdx docs/api/qiskit/0.31/aer.mdx docs/api/qiskit/0.31/aqua.mdx docs/api/qiskit/0.31/ibmq-provider.mdx docs/api/qiskit/0.31/ibmq_jupyter.mdx docs/api/qiskit/0.31/ibmq_visualization.mdx docs/api/qiskit/0.31/parallel.mdx docs/api/qiskit/0.33/aer.mdx docs/api/qiskit/0.33/ibmq-provider.mdx docs/api/qiskit/0.33/ibmq_jupyter.mdx docs/api/qiskit/0.33/ibmq_visualization.mdx docs/api/qiskit/0.33/parallel.mdx docs/api/qiskit/0.33/transpiler_builtin_plugins.mdx docs/api/qiskit/0.32/aer.mdx docs/api/qiskit/0.32/aqua.mdx docs/api/qiskit/0.32/ibmq-provider.mdx docs/api/qiskit/0.32/ibmq_jupyter.mdx docs/api/qiskit/0.32/ibmq_visualization.mdx docs/api/qiskit/0.32/parallel.mdx docs/api/qiskit/0.35/aer.mdx docs/api/qiskit/0.35/ibmq-provider.mdx docs/api/qiskit/0.35/ibmq_jupyter.mdx docs/api/qiskit/0.35/ibmq_visualization.mdx docs/api/qiskit/0.35/parallel.mdx docs/api/qiskit/0.35/transpiler_builtin_plugins.mdx docs/api/qiskit/0.36/aer.mdx docs/api/qiskit/0.36/ibmq-provider.mdx docs/api/qiskit/0.36/ibmq_jupyter.mdx docs/api/qiskit/0.36/ibmq_visualization.mdx docs/api/qiskit/0.36/parallel.mdx docs/api/qiskit/0.36/transpiler_builtin_plugins.mdx docs/api/qiskit/0.37/aer.mdx docs/api/qiskit/0.37/ibmq-provider.mdx docs/api/qiskit/0.37/ibmq_jupyter.mdx docs/api/qiskit/0.37/ibmq_visualization.mdx docs/api/qiskit/0.37/parallel.mdx docs/api/qiskit/0.37/transpiler_builtin_plugins.mdx docs/api/qiskit/0.38/aer.mdx docs/api/qiskit/0.38/ibmq-provider.mdx docs/api/qiskit/0.38/ibmq_jupyter.mdx docs/api/qiskit/0.38/ibmq_visualization.mdx docs/api/qiskit/0.38/parallel.mdx docs/api/qiskit/0.38/transpiler_builtin_plugins.mdx docs/api/qiskit/0.39/aer.mdx docs/api/qiskit/0.39/ibmq-provider.mdx docs/api/qiskit/0.39/ibmq_jupyter.mdx docs/api/qiskit/0.39/ibmq_visualization.mdx docs/api/qiskit/0.39/parallel.mdx docs/api/qiskit/0.39/transpiler_builtin_plugins.mdx docs/api/qiskit/0.40/aer.mdx docs/api/qiskit/0.40/ibmq-provider.mdx docs/api/qiskit/0.40/ibmq_jupyter.mdx docs/api/qiskit/0.40/ibmq_visualization.mdx docs/api/qiskit/0.40/parallel.mdx docs/api/qiskit/0.40/transpiler_builtin_plugins.mdx docs/api/qiskit/0.41/aer.mdx docs/api/qiskit/0.41/ibmq-provider.mdx docs/api/qiskit/0.41/ibmq_jupyter.mdx docs/api/qiskit/0.41/ibmq_visualization.mdx docs/api/qiskit/0.41/parallel.mdx docs/api/qiskit/0.41/transpiler_builtin_plugins.mdx docs/api/qiskit/0.42/aer.mdx docs/api/qiskit/0.42/ibmq-provider.mdx docs/api/qiskit/0.42/ibmq_jupyter.mdx docs/api/qiskit/0.42/ibmq_visualization.mdx docs/api/qiskit/0.42/parallel.mdx docs/api/qiskit/0.42/transpiler_builtin_plugins.mdx docs/api/qiskit/0.43/transpiler_builtin_plugins.mdx docs/api/qiskit/0.44/transpiler_builtin_plugins.mdx docs/api/qiskit/0.46/transpiler_builtin_plugins.mdx docs/api/qiskit/0.45/transpiler_builtin_plugins.mdx