Update Sphinx theme (#693)

* Update Sphinx theme Co-authored-by: Frank Harkins <36071638+frankharkins@users.noreply.github.com> * Fix docs heading levels --------- Co-authored-by: Frank Harkins <36071638+frankharkins@users.noreply.github.com> Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
qiskit-community · Oct 16, 2023 · 17a6f85 · 17a6f85
1 parent 92977fe
commit 17a6f85
Show file tree

Hide file tree

Showing 10 changed files with 18 additions and 29 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -177,19 +177,8 @@
 
 # -- Options for HTML output -------------------------------------------------
 
-html_theme = "qiskit_sphinx_theme"
-html_theme_options = {
-    "logo_only": False,
-    "display_version": True,
-    "prev_next_buttons_location": "bottom",
-    "style_external_links": False,
-    # Toc options
-    "collapse_navigation": True,
-    "sticky_navigation": True,
-    "navigation_depth": 4,
-    "includehidden": True,
-    "titles_only": False,
-}
+html_theme = "qiskit-ecosystem"
+html_title = f"{project} {release}"
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),

diff --git a/qiskit_machine_learning/algorithms/__init__.py b/qiskit_machine_learning/algorithms/__init__.py
@@ -19,7 +19,7 @@
 .. currentmodule:: qiskit_machine_learning.algorithms
 
 Machine Learning Base Classes
-=============================
+-----------------------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -30,7 +30,7 @@
    SerializableModelMixin
 
 Machine Learning Objective Functions
-====================================
+------------------------------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -41,7 +41,7 @@
    OneHotObjectiveFunction
 
 Algorithms
-==========
+----------
 
 Classifiers
 +++++++++++

diff --git a/qiskit_machine_learning/circuit/library/__init__.py b/qiskit_machine_learning/circuit/library/__init__.py
@@ -20,7 +20,7 @@
 .. currentmodule:: qiskit_machine_learning.circuit.library
 
 Feature Maps
-============
+------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -30,7 +30,7 @@
    RawFeatureVector
 
 Helper Circuits
-===============
+---------------
 
 .. autosummary::
    :toctree: ../stubs/

diff --git a/qiskit_machine_learning/connectors/__init__.py b/qiskit_machine_learning/connectors/__init__.py
@@ -19,7 +19,7 @@
 .. currentmodule:: qiskit_machine_learning.connectors
 
 Connectors
-======================
+----------------------
 
 .. autosummary::
    :toctree: ../stubs/

diff --git a/qiskit_machine_learning/datasets/__init__.py b/qiskit_machine_learning/datasets/__init__.py
@@ -19,7 +19,7 @@
 .. currentmodule:: qiskit_machine_learning.datasets
 
 Datasets
-========
+--------
 
 .. autosummary::
    :toctree: ../stubs/

diff --git a/qiskit_machine_learning/kernels/__init__.py b/qiskit_machine_learning/kernels/__init__.py
@@ -36,7 +36,7 @@
 .. currentmodule:: qiskit_machine_learning.kernels
 
 Quantum Kernels
-===============
+---------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -50,7 +50,7 @@
    TrainableFidelityStatevectorKernel
 
 Submodules
-==========
+----------
 
 .. autosummary::
    :toctree:

diff --git a/qiskit_machine_learning/neural_networks/__init__.py b/qiskit_machine_learning/neural_networks/__init__.py
@@ -28,7 +28,7 @@
 .. currentmodule:: qiskit_machine_learning.neural_networks
 
 Neural Network Base Classes
-===========================
+---------------------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -37,7 +37,7 @@
    NeuralNetwork
 
 Neural Networks
-===============
+---------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -47,7 +47,7 @@
    SamplerQNN
 
 Neural Network Metrics
-======================
+----------------------
 
 .. autosummary::
    :toctree: ../stubs/

diff --git a/qiskit_machine_learning/utils/__init__.py b/qiskit_machine_learning/utils/__init__.py
@@ -19,7 +19,7 @@
 .. currentmodule:: qiskit_machine_learning.utils
 
 Utilities
-==========
+----------
 
 .. autosummary::
    :toctree:

diff --git a/qiskit_machine_learning/utils/loss_functions/__init__.py b/qiskit_machine_learning/utils/loss_functions/__init__.py
@@ -20,7 +20,7 @@
 .. currentmodule:: qiskit_machine_learning.utils.loss_functions
 
 Loss Function Base Class
-========================
+------------------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -30,7 +30,7 @@
    KernelLoss
 
 Loss Functions
-==============
+--------------
 
 .. autosummary::
    :toctree: ../stubs/

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -16,4 +16,4 @@ qiskit-aer>=0.11.2
 mypy>=0.981
 mypy-extensions>=0.4.3
 nbsphinx
-qiskit_sphinx_theme~=1.12.0
+qiskit_sphinx_theme~=1.16.0