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

Eric-Arellano · 2023-10-02T13:12:51Z

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:

documentation/scripts/lib/sphinx/addFrontMatter.ts

Lines 19 to 30 in e872441

    
               if (result.meta.python_api_name) { 
        
                 result.markdown = `--- 
        
           title: ${getLastPartFromFullIdentifier(result.meta.python_api_name)} 
        
           description: API reference for ${result.meta.python_api_name} 
        
           in_page_toc_min_heading_level: 1 
        
           python_api_type: ${result.meta.python_api_type} 
        
           python_api_name: ${result.meta.python_api_name} 
        
           --- 
        
           ${markdown} 
        
           `; 
        
               }

TBD how we determine the title and description!

Update: make sure CI enforces it, per #793.

The text was updated successfully, but these errors were encountered:

Closes #9. Once this lands, we will update the closed source repository to start consuming this repository and remove the API pipeline from there. Note that these API docs are not identical to the closed source versions! This uses qiskit-ibm-provider 0.7 rather than 0.6.3, and qiskit-ibm-runtime 0.12.2 rather than 0.11.3. We skip spellcheck issues and the metadata check for certain files (#66) to facilitate landing this. They were already issues in closed source.

axelhzf · 2023-12-11T12:48:34Z

Perhaps we can use the filename as a fallback?

Closes #558. Before: <img width="248" alt="Screenshot 2023-12-29 at 1 38 50 PM" src="https://github.com/Qiskit/documentation/assets/14852634/299bd13b-e681-4105-93b6-9525312c547a"> After: <img width="251" alt="Screenshot 2023-12-29 at 1 39 08 PM" src="https://github.com/Qiskit/documentation/assets/14852634/21c900af-b44c-4c69-9ac5-133bbc251b00"> This new left sidebar layout aligns with Qiskit. The consistency is useful, but also I think this new layout is more functional anyways. It reduces the amount of nesting. It also allows us to collapse the left sidebar by default, which we do in the rest of the docs. ## Changes index page Before, the index page was the description for the code components belonging to the top-level modules `qiskit_ibm_provider` and `qiskit_ibm_runtime`, rather than enumerating what all the modules are: Before: <img width="625" alt="Screenshot 2023-12-29 at 1 40 19 PM" src="https://github.com/Qiskit/documentation/assets/14852634/c2e08d6f-365e-4775-8719-c6aad01cc77a"> After: <img width="658" alt="Screenshot 2023-12-29 at 1 41 30 PM" src="https://github.com/Qiskit/documentation/assets/14852634/4a58cdd7-48f3-4e28-a0e4-cb716f095e4e"> Note that this index page is not accessible from the left sidebar; it's not clear what we would call it. But you can access it from the top nav-bar: <img width="234" alt="Screenshot 2023-12-29 at 1 42 13 PM" src="https://github.com/Qiskit/documentation/assets/14852634/4c9ebdd7-9bf2-45ed-8c3b-b998d319d5ec"> ## Metadata The new index pages have never had metadata. That's because we don't have any technique to determine from Sphinx programatically its metadata because the Sphinx generated HTML page is missing it: https://github.com/Qiskit/documentation/blob/92b3fa45c10aa917c3fbc7ada861b2db55203902/scripts/lib/sphinx/PythonObjectMeta.ts#L13-L24 This is an instance of #66. I think we need a generic solution to that problem, such as Axel's suggestion to use filenames as a fallback. But, it's important that the metadata is high quality for these two index pages since they are so high-profile. So, I propose hardcoding the metadata for them. Because there are only two files, I think this approach is acceptable; obviously it wouldn't scale if we were hardcoding dozens of files.

Closes #793. This unblocks us starting to check API docs in #66. It also speeds up the workflow for non-API docs, which is valuable because non-API and API docs have such different workflows. I only added an `--apis` argument rather than e.g. `--current-apis` vs `--historical-apis` because this check is fast enough to not need the nuance. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>

Eric-Arellano · 2024-02-15T19:00:41Z

#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

Part of #66. We were failing to detect modules using old versions of Sphinx that set the module metadata in `<div>` rather than `<span>` or `<section>`. Some of the module pages had no metadata at all, whereas some were misclassified as `functions` corresponding to the first function in the module's page. Fixing this metadata will fix the HTML meta properties, and it also fixes the table of contents to have correct nesting.

Closes Qiskit#9. Once this lands, we will update the closed source repository to start consuming this repository and remove the API pipeline from there. Note that these API docs are not identical to the closed source versions! This uses qiskit-ibm-provider 0.7 rather than 0.6.3, and qiskit-ibm-runtime 0.12.2 rather than 0.11.3. We skip spellcheck issues and the metadata check for certain files (Qiskit#66) to facilitate landing this. They were already issues in closed source.

Closes Qiskit#558. Before: <img width="248" alt="Screenshot 2023-12-29 at 1 38 50 PM" src="https://github.com/Qiskit/documentation/assets/14852634/299bd13b-e681-4105-93b6-9525312c547a"> After: <img width="251" alt="Screenshot 2023-12-29 at 1 39 08 PM" src="https://github.com/Qiskit/documentation/assets/14852634/21c900af-b44c-4c69-9ac5-133bbc251b00"> This new left sidebar layout aligns with Qiskit. The consistency is useful, but also I think this new layout is more functional anyways. It reduces the amount of nesting. It also allows us to collapse the left sidebar by default, which we do in the rest of the docs. ## Changes index page Before, the index page was the description for the code components belonging to the top-level modules `qiskit_ibm_provider` and `qiskit_ibm_runtime`, rather than enumerating what all the modules are: Before: <img width="625" alt="Screenshot 2023-12-29 at 1 40 19 PM" src="https://github.com/Qiskit/documentation/assets/14852634/c2e08d6f-365e-4775-8719-c6aad01cc77a"> After: <img width="658" alt="Screenshot 2023-12-29 at 1 41 30 PM" src="https://github.com/Qiskit/documentation/assets/14852634/4a58cdd7-48f3-4e28-a0e4-cb716f095e4e"> Note that this index page is not accessible from the left sidebar; it's not clear what we would call it. But you can access it from the top nav-bar: <img width="234" alt="Screenshot 2023-12-29 at 1 42 13 PM" src="https://github.com/Qiskit/documentation/assets/14852634/4c9ebdd7-9bf2-45ed-8c3b-b998d319d5ec"> ## Metadata The new index pages have never had metadata. That's because we don't have any technique to determine from Sphinx programatically its metadata because the Sphinx generated HTML page is missing it: https://github.com/Qiskit/documentation/blob/60c836afbf30729fa30a97086b5812b08970ded5/scripts/lib/sphinx/PythonObjectMeta.ts#L13-L24 This is an instance of Qiskit#66. I think we need a generic solution to that problem, such as Axel's suggestion to use filenames as a fallback. But, it's important that the metadata is high quality for these two index pages since they are so high-profile. So, I propose hardcoding the metadata for them. Because there are only two files, I think this approach is acceptable; obviously it wouldn't scale if we were hardcoding dozens of files.

Closes Qiskit#793. This unblocks us starting to check API docs in Qiskit#66. It also speeds up the workflow for non-API docs, which is valuable because non-API and API docs have such different workflows. I only added an `--apis` argument rather than e.g. `--current-apis` vs `--historical-apis` because this check is fast enough to not need the nuance. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>

) Part of Qiskit#66. We were failing to detect modules using old versions of Sphinx that set the module metadata in `<div>` rather than `<span>` or `<section>`. Some of the module pages had no metadata at all, whereas some were misclassified as `functions` corresponding to the first function in the module's page. Fixing this metadata will fix the HTML meta properties, and it also fixes the table of contents to have correct nesting.

Eric-Arellano · 2024-09-06T16:21:33Z

#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

Eric-Arellano added the infra 🏗️ label Oct 2, 2023

github-project-automation bot added this to Docs Planning Oct 2, 2023

Eric-Arellano self-assigned this Oct 2, 2023

Eric-Arellano mentioned this issue Oct 2, 2023

Generate API docs #65

Merged

Eric-Arellano added this to the Infra MVP fast-follow milestone Oct 2, 2023

Eric-Arellano modified the milestones: Infra MVP fast-follow, mid-oct release Oct 5, 2023

Eric-Arellano modified the milestones: mid-oct release, dec release Oct 16, 2023

Eric-Arellano removed their assignment Nov 6, 2023

Eric-Arellano modified the milestones: 23-11-29 dec release, 24-01-30 Qiskit 1.0 Nov 21, 2023

Eric-Arellano mentioned this issue Jan 2, 2024

Provider and Runtime show modules as top-level in sidebar #561

Merged

arnaucasau mentioned this issue Jan 4, 2024

Add more tests for API generation script #581

Merged

Eric-Arellano modified the milestones: 24-02-13 Qiskit 1.0, 24-03-12 qiskit 1.0 release part 2 Feb 1, 2024

Eric-Arellano changed the title ~~API pipeline needs to add "front matter" (title) to several pages~~ API pipeline needs to add "front matter" (title / metadata) to several pages Feb 15, 2024

Eric-Arellano mentioned this issue Feb 15, 2024

Don't check metadata for API docs by default #817

Merged

Eric-Arellano self-assigned this Feb 15, 2024

Eric-Arellano mentioned this issue Feb 15, 2024

Fix metadata detection of modules for historical Qiskit docs #821

Merged

javabster modified the milestones: 24-05-21 qiskit 1.0 release part 2, runtime primitives release Feb 16, 2024

javabster moved this to In Progress in Docs Planning Feb 19, 2024

Eric-Arellano moved this from In Progress to Todo in Docs Planning Feb 26, 2024

javabster moved this from Todo to In Progress in Docs Planning Feb 26, 2024

Eric-Arellano removed the status in Docs Planning Feb 29, 2024

Eric-Arellano modified the milestones: 24-03-01 runtime primitives release, 24-05-21 qiskit 1.0 release part 2 Feb 29, 2024

Eric-Arellano removed their assignment Feb 29, 2024

javabster removed this from the 24-05-21 qiskit 1.0 release part 2 milestone Mar 29, 2024

Eric-Arellano self-assigned this Sep 6, 2024

Eric-Arellano removed their assignment Sep 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

Eric-Arellano commented Oct 2, 2023 •

edited

Loading

axelhzf commented Dec 11, 2023

Eric-Arellano commented Feb 15, 2024

Eric-Arellano commented Sep 6, 2024 •

edited

Loading

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

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

Comments

Eric-Arellano commented Oct 2, 2023 • edited Loading

axelhzf commented Dec 11, 2023

Eric-Arellano commented Feb 15, 2024

Eric-Arellano commented Sep 6, 2024 • edited Loading

Eric-Arellano commented Oct 2, 2023 •

edited

Loading

Eric-Arellano commented Sep 6, 2024 •

edited

Loading