Updates to new Ecosystem theme. (#562)

* Updates to new Ecosystem 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>
qiskit-community · Oct 15, 2023 · e620f08 · e620f08
1 parent cddfbbb
commit e620f08
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 25 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -176,19 +176,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_optimization/algorithms/__init__.py b/qiskit_optimization/algorithms/__init__.py
@@ -19,7 +19,7 @@
 .. currentmodule:: qiskit_optimization.algorithms
 
 Base classes for algorithms and results
-=======================================
+---------------------------------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -31,7 +31,7 @@
    BaseAggregator
 
 Algorithms and results
-======================
+----------------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -63,7 +63,7 @@
    WarmStartQAOAFactory
 
 Submodules
-==========
+----------
 
 .. autosummary::
    :toctree:

diff --git a/qiskit_optimization/algorithms/qrao/__init__.py b/qiskit_optimization/algorithms/qrao/__init__.py
@@ -93,7 +93,7 @@
 
 
 Quantum Random Access Encoding and Optimization
-===============================================
+-----------------------------------------------
 .. autosummary::
     :toctree: ../stubs/
     :nosignatures:
@@ -104,7 +104,7 @@
     QuantumRandomAccessOptimizationResult
 
 Rounding schemes
-================
+----------------
 
 .. autosummary::
     :toctree: ../stubs/

diff --git a/qiskit_optimization/applications/__init__.py b/qiskit_optimization/applications/__init__.py
@@ -19,7 +19,7 @@
 Applications for common optimization problems.
 
 Base classes for applications
-=======================================
+---------------------------------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -29,7 +29,7 @@
    GraphOptimizationApplication
 
 Applications
-======================
+--------------------
 .. autosummary::
    :toctree: ../stubs/
    :nosignatures:

diff --git a/qiskit_optimization/converters/__init__.py b/qiskit_optimization/converters/__init__.py
@@ -22,7 +22,7 @@
 :class:`~qiskit_optimization.algorithms.OptimizationResult`.
 
 Base class for converters
-=========================
+-------------------------
 
 .. autosummary::
    :toctree: ../stubs/
@@ -31,7 +31,7 @@
    QuadraticProgramConverter
 
 Converters
-==========
+----------
 
 .. autosummary::
    :toctree: ../stubs/

diff --git a/qiskit_optimization/problems/__init__.py b/qiskit_optimization/problems/__init__.py
@@ -17,7 +17,7 @@
 .. currentmodule:: qiskit_optimization.problems
 
 Quadratic program
-=================
+-----------------
 Structures for defining an optimization problem.
 
 Note:

diff --git a/qiskit_optimization/translators/__init__.py b/qiskit_optimization/translators/__init__.py
@@ -20,7 +20,7 @@
 other optimization models or other objects.
 
 Translators
-======================
+----------------------
 .. autosummary::
    :toctree: ../stubs/
    :nosignatures:

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