Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to new Ecosystem theme. #562

Merged
merged 3 commits into from
Oct 15, 2023
+14 −25
Merged

Updates to new Ecosystem theme. #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a9dd87
Updates to new Ecosystem theme.
arnaucasau Sep 28, 2023
9cdb4c2
Merge branch 'main' into update-sphinx-theme
arnaucasau Oct 13, 2023
2eaaaf9
Fix docs heading levels
arnaucasau Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
6 changes: 3 additions & 3 deletions qiskit_optimization/algorithms/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
.. currentmodule:: qiskit_optimization.algorithms

Base classes for algorithms and results
=======================================
---------------------------------------

.. autosummary::
:toctree: ../stubs/
Expand All @@ -31,7 +31,7 @@
BaseAggregator

Algorithms and results
======================
----------------------

.. autosummary::
:toctree: ../stubs/
Expand Down Expand Up @@ -63,7 +63,7 @@
WarmStartQAOAFactory

Submodules
==========
----------

.. autosummary::
:toctree:
Expand Down
4 changes: 2 additions & 2 deletions qiskit_optimization/algorithms/qrao/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@


Quantum Random Access Encoding and Optimization
===============================================
-----------------------------------------------
.. autosummary::
:toctree: ../stubs/
:nosignatures:
Expand All @@ -104,7 +104,7 @@
QuantumRandomAccessOptimizationResult

Rounding schemes
================
----------------

.. autosummary::
:toctree: ../stubs/
Expand Down
4 changes: 2 additions & 2 deletions qiskit_optimization/applications/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
Applications for common optimization problems.

Base classes for applications
=======================================
---------------------------------------

.. autosummary::
:toctree: ../stubs/
Expand All @@ -29,7 +29,7 @@
GraphOptimizationApplication

Applications
======================
--------------------
.. autosummary::
:toctree: ../stubs/
:nosignatures:
Expand Down
4 changes: 2 additions & 2 deletions qiskit_optimization/converters/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
:class:`~qiskit_optimization.algorithms.OptimizationResult`.

Base class for converters
=========================
-------------------------

.. autosummary::
:toctree: ../stubs/
Expand All @@ -31,7 +31,7 @@
QuadraticProgramConverter

Converters
==========
----------

.. autosummary::
:toctree: ../stubs/
Expand Down
2 changes: 1 addition & 1 deletion qiskit_optimization/problems/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
.. currentmodule:: qiskit_optimization.problems

Quadratic program
=================
-----------------
Structures for defining an optimization problem.

Note:
Expand Down
2 changes: 1 addition & 1 deletion qiskit_optimization/translators/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
other optimization models or other objects.

Translators
======================
----------------------
.. autosummary::
:toctree: ../stubs/
:nosignatures:
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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