From 5a9dd87f725c1a83183edd6796d9ca32bc8bd4ac Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Thu, 28 Sep 2023 18:44:56 +0200 Subject: [PATCH 1/2] Updates to new Ecosystem theme. Co-authored-by: Frank Harkins <36071638+frankharkins@users.noreply.github.com> --- docs/conf.py | 15 ++------------- requirements-dev.txt | 2 +- 2 files changed, 3 insertions(+), 14 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1b9f6d059..aaf982c86 100644 --- 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/requirements-dev.txt b/requirements-dev.txt index dff0b8d7e..0aefb685d 100644 --- 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 From 2eaaaf9341e47a902631191a2fbd0468685f4ba0 Mon Sep 17 00:00:00 2001 From: Arnau Casau Date: Fri, 13 Oct 2023 18:57:26 +0200 Subject: [PATCH 2/2] Fix docs heading levels --- qiskit_optimization/algorithms/__init__.py | 6 +++--- qiskit_optimization/algorithms/qrao/__init__.py | 4 ++-- qiskit_optimization/applications/__init__.py | 4 ++-- qiskit_optimization/converters/__init__.py | 4 ++-- qiskit_optimization/problems/__init__.py | 2 +- qiskit_optimization/translators/__init__.py | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/qiskit_optimization/algorithms/__init__.py b/qiskit_optimization/algorithms/__init__.py index 46bb4c548..00897e6ea 100644 --- 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 index 9fa64ba9c..ad7a6ce8e 100644 --- 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 index 79347c0cf..fdee5131e 100644 --- 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 index 6e0acaf09..c88aa055f 100644 --- 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 index a18c1e890..50bd2501a 100644 --- 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 index 61ae4b712..913c23922 100644 --- 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: