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

Update Sphinx theme #693

Merged
merged 5 commits into from
Oct 16, 2023
Merged

Update Sphinx theme #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f5f3835
Update Sphinx theme
arnaucasau Sep 28, 2023
bcc2df3
Merge branch 'main' into update-sphinx-theme
woodsp-ibm Sep 29, 2023
461b39d
Merge branch 'main' into update-sphinx-theme
arnaucasau Oct 13, 2023
d72aa4b
Fix docs heading levels
arnaucasau Oct 16, 2023
6c3deed
Merge branch 'update-sphinx-theme' of https://github.com/arnaucasau/q…
arnaucasau Oct 16, 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 @@ -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),
Expand Down
6 changes: 3 additions & 3 deletions qiskit_machine_learning/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_machine_learning.algorithms

Machine Learning Base Classes
=============================
-----------------------------

.. autosummary::
:toctree: ../stubs/
Expand All @@ -30,7 +30,7 @@
SerializableModelMixin

Machine Learning Objective Functions
====================================
------------------------------------

.. autosummary::
:toctree: ../stubs/
Expand All @@ -41,7 +41,7 @@
OneHotObjectiveFunction

Algorithms
==========
----------

Classifiers
+++++++++++
Expand Down
4 changes: 2 additions & 2 deletions qiskit_machine_learning/circuit/library/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
.. currentmodule:: qiskit_machine_learning.circuit.library

Feature Maps
============
------------

.. autosummary::
:toctree: ../stubs/
Expand All @@ -30,7 +30,7 @@
RawFeatureVector

Helper Circuits
===============
---------------

.. autosummary::
:toctree: ../stubs/
Expand Down
2 changes: 1 addition & 1 deletion qiskit_machine_learning/connectors/__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_machine_learning.connectors

Connectors
======================
----------------------

.. autosummary::
:toctree: ../stubs/
Expand Down
2 changes: 1 addition & 1 deletion qiskit_machine_learning/datasets/__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_machine_learning.datasets

Datasets
========
--------

.. autosummary::
:toctree: ../stubs/
Expand Down
4 changes: 2 additions & 2 deletions qiskit_machine_learning/kernels/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
.. currentmodule:: qiskit_machine_learning.kernels

Quantum Kernels
===============
---------------

.. autosummary::
:toctree: ../stubs/
Expand All @@ -50,7 +50,7 @@
TrainableFidelityStatevectorKernel

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

.. autosummary::
:toctree:
Expand Down
6 changes: 3 additions & 3 deletions qiskit_machine_learning/neural_networks/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
.. currentmodule:: qiskit_machine_learning.neural_networks

Neural Network Base Classes
===========================
---------------------------

.. autosummary::
:toctree: ../stubs/
Expand All @@ -37,7 +37,7 @@
NeuralNetwork

Neural Networks
===============
---------------

.. autosummary::
:toctree: ../stubs/
Expand All @@ -47,7 +47,7 @@
SamplerQNN

Neural Network Metrics
======================
----------------------

.. autosummary::
:toctree: ../stubs/
Expand Down
2 changes: 1 addition & 1 deletion qiskit_machine_learning/utils/__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_machine_learning.utils

Utilities
==========
----------

.. autosummary::
:toctree:
Expand Down
4 changes: 2 additions & 2 deletions qiskit_machine_learning/utils/loss_functions/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
.. currentmodule:: qiskit_machine_learning.utils.loss_functions

Loss Function Base Class
========================
------------------------

.. autosummary::
:toctree: ../stubs/
Expand All @@ -30,7 +30,7 @@
KernelLoss

Loss Functions
==============
--------------

.. autosummary::
:toctree: ../stubs/
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 @@ -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