Upgrade to qiskit-sphinx-theme 1.13 (#1772)

The main change is the new `qiskit` theme based on Furo, but we don't yet activate that. Otherwise, the only relevant change is simplifying the API for custom directives. And fixing 404 errors about missing Thebe files. -- This also fixes the images not working for two `qiskit-card`s, which I accidentally broke in #1749. For `qiskit-card`, the images apparently must live in the `_static` folder for Sphinx to know to include the images in the final build. This is unlike when we normally use images.
Qiskit · Jul 13, 2023 · d8107ce · d8107ce
1 parent 4378b14
commit d8107ce
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 108 deletions.
diff --git a/constraints.txt b/constraints.txt
@@ -2,7 +2,6 @@ astroid==2.14.2
 pylint==2.16.2
 cryptography==39.0.1
 decorator==4.4.2
-docutils==0.16
 
 # importlib_metadata 5.0 is broken with stevedore, so pin to the last
 # functional version in the 4.x series.

diff --git a/docs/images/ibm_qlab.png → docs/_static/images/ibm_qlab.png b/docs/images/ibm_qlab.png → docs/_static/images/ibm_qlab.png
diff --git a/docs/images/strangeworks.png → docs/_static/images/strangeworks.png b/docs/images/strangeworks.png → docs/_static/images/strangeworks.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -88,6 +88,8 @@
     "tabs-color-label-active": "rgb(138, 63, 252)",
     "tabs-color-label-inactive": "rgb(221, 225, 230)",
 }
+
+html_static_path = ["_static"]
 templates_path = ["_templates"]
 
 source_suffix = ".rst"

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -75,34 +75,18 @@ going to run and install the packages.  There are three main ways to do this:
 
         The following cloud vendors have Qiskit pre-installed in their environments:
 
-       .. raw:: html
-
-          <div id="tutorial-cards-container">
-          <hr class="tutorials-hr">
-          <div class="row">
-          <div id="tutorial-cards">
-          <div class="list">
-
-       .. qiskit-card-item::
+       .. qiskit-card::
           :header: IBM Quantum Lab
           :card_description: Build quantum applications and experiments with Qiskit in a cloud programming environment.
-          :image: images/ibm_qlab.png
+          :image: _static/images/ibm_qlab.png
           :link: https://quantum-computing.ibm.com/
 
-       .. qiskit-card-item::
+       .. qiskit-card::
           :header: Strangeworks
           :card_description: A platform that enables users and organizations to easily apply quantum computing to their most pressing problems and research.
-          :image: images/strangeworks.png
+          :image: _static/images/strangeworks.png
           :link: https://strangeworks.com/
 
-       .. raw:: html
-
-          </div>
-          <div class="pagination d-flex justify-content-center"></div>
-          </div>
-          </div>
-          </div>
-
     .. tab-item:: Install from source
 
        Installing the elements from source allows you to access the most recently
@@ -507,27 +491,20 @@ Tier 3 platforms are currently:
 Ready to get going?...
 ======================
 
-.. raw:: html
-
-   <div class="tutorials-callout-container">
-      <div class="row">
-
-.. qiskit-call-to-action-item::
-   :description: Learn how to build, execute, and post-process quantum circuits with Qiskit.
-   :header: Qiskit from the ground up
-   :button_link:  intro_tutorial1.html
-   :button_text: Start learning Qiskit
-
+.. qiskit-call-to-action-grid::
 
-.. qiskit-call-to-action-item::
-   :description: Find out how to leverage Qiskit for everything from single-circuits to full quantum application development.
-   :header: Dive into the tutorials
-   :button_link:  tutorials.html
-   :button_text: Qiskit tutorials
+   .. qiskit-call-to-action-item::
+      :description: Learn how to build, execute, and post-process quantum circuits with Qiskit.
+      :header: Qiskit from the ground up
+      :button_link:  intro_tutorial1.html
+      :button_text: Start learning Qiskit
 
-.. raw:: html
+   .. qiskit-call-to-action-item::
+      :description: Find out how to leverage Qiskit for everything from single-circuits to full quantum application development.
+      :header: Dive into the tutorials
+      :button_link:  tutorials.html
+      :button_text: Qiskit tutorials
 
-   </div>
 
 .. Hiding - Indices and tables
    :ref:`genindex`

diff --git a/docs/index.rst b/docs/index.rst
@@ -12,63 +12,49 @@ them on real quantum computers or classical simulators. Qiskit is already in use
 around the world by beginners, hobbyists, educators, researchers, and commercial companies.
 
 
-.. raw:: html
+.. qiskit-call-to-action-grid::
 
-  <div class="tutorials-callout-container"><div class="row">
+    .. qiskit-call-to-action-item::
+      :header: Access to quantum systems
+      :description: Find out which Qiskit providers support execution on real quantum services.
+      :button_link:  https://qiskit.org/providers
+      :button_text: Quantum providers
 
-
-.. qiskit-call-to-action-item::
-  :header: Access to quantum systems
-  :description: Find out which Qiskit providers support execution on real quantum services.
-  :button_link:  https://qiskit.org/providers
-  :button_text: Quantum providers
-
-
-.. qiskit-call-to-action-item::
-  :header: Qiskit ecosystem
-  :description: The Qiskit ecosystem consists of projects, tools, utilities, libraries and tutorials from a broad community of developers and researchers.
-  :button_link:  https://qiskit.org/ecosystem/
-  :button_text: Explore the Qiskit ecosystem
-
-.. raw:: html
-
-  </div></div>
+    .. qiskit-call-to-action-item::
+      :header: Qiskit ecosystem
+      :description: The Qiskit ecosystem consists of projects, tools, utilities, libraries and tutorials from a broad community of developers and researchers.
+      :button_link:  https://qiskit.org/ecosystem/
+      :button_text: Explore the Qiskit ecosystem
 
 
 Main Qiskit-related projects
 ############################
 
-.. raw:: html
-
-  <div class="tutorials-callout-container"><div class="row">
-
-.. qiskit-call-to-action-item::
-  :header: Qiskit Experiments
-  :description: Run characterization, calibration, and verification experiments
-  :button_link: https://qiskit.org/ecosystem/experiments/
-  :button_text: Qiskit Experiments documentation
-
-.. qiskit-call-to-action-item::
-  :header: Qiskit Dynamics
-  :description: Tools for building and solving models of quantum systems in Qiskit
-  :button_link: https://qiskit.org/ecosystem/dynamics/
-  :button_text: Qiskit Dynamics documentation
-
-.. qiskit-call-to-action-item::
-  :header: Qiskit IBM Runtime
-  :description: Qiskit Runtime is a cloud base implementation of the Qiskit primitives to effectively execute workloads on IBM Quantum systems.
-  :button_link:  https://qiskit.org/ecosystem/ibm-runtime/
-  :button_text: Qiskit Runtime documentation
-
-.. qiskit-call-to-action-item::
-  :header: IBM Quantum Provider
-  :description: A Qiskit provider that allows accessing the IBM Quantum systems and cloud simulators.
-  :button_link:  https://qiskit.org/ecosystem/ibm-runtime/
-  :button_text: Qiskit IBM provider documentation
-
-.. raw:: html
-
-  </div></div>
+.. qiskit-call-to-action-grid::
+
+    .. qiskit-call-to-action-item::
+      :header: Qiskit Experiments
+      :description: Run characterization, calibration, and verification experiments
+      :button_link: https://qiskit.org/ecosystem/experiments/
+      :button_text: Qiskit Experiments documentation
+
+    .. qiskit-call-to-action-item::
+      :header: Qiskit Dynamics
+      :description: Tools for building and solving models of quantum systems in Qiskit
+      :button_link: https://qiskit.org/ecosystem/dynamics/
+      :button_text: Qiskit Dynamics documentation
+
+    .. qiskit-call-to-action-item::
+      :header: Qiskit IBM Runtime
+      :description: Qiskit Runtime is a cloud base implementation of the Qiskit primitives to effectively execute workloads on IBM Quantum systems.
+      :button_link:  https://qiskit.org/ecosystem/ibm-runtime/
+      :button_text: Qiskit Runtime documentation
+
+    .. qiskit-call-to-action-item::
+      :header: IBM Quantum Provider
+      :description: A Qiskit provider that allows accessing the IBM Quantum systems and cloud simulators.
+      :button_link:  https://qiskit.org/ecosystem/ibm-runtime/
+      :button_text: Qiskit IBM provider documentation
 
 
 .. toctree::

diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -9,28 +9,12 @@ Tutorials
 Introductory
 ============
 
-.. raw:: html
-
-   <div id="tutorial-cards-container">
-   <hr class="tutorials-hr">
-   <div class="row">
-   <div id="tutorial-cards">
-   <div class="list">
-
-.. qiskit-card-item::
+.. qiskit-card::
    :header: Qiskit warmup
    :card_description: An introduction to Qiskit and the primary user workflow.
    :image: _static/images/logo.png
    :link: intro_tutorial1.html
 
-.. raw:: html
-
-   </div>
-   <div class="pagination d-flex justify-content-center"></div>
-   </div>
-   </div>
-
-
 Quantum circuits
 ================
 

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,7 +1,7 @@
 qiskit-ibmq-provider[visualization]
 numpy>=1.17
-Sphinx>=5.0
-qiskit-sphinx-theme~=1.12.0
+Sphinx>=6.0
+qiskit-sphinx-theme~=1.13.0
 pylatexenc>=1.4
 sphinx-automodapi
 jupyter