Update Sphinx theme (#121)

qiskit-community · Oct 23, 2023 · 49d0254 · 49d0254
1 parent 88650d1
commit 49d0254
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,6 +35,7 @@
 with open(version_path) as fp:
     exec(fp.read(), version_dict)
 version = version_dict["__version__"]
+release = version_dict["__version__"]
 
 extensions = [
     "sphinx.ext.napoleon",
@@ -48,6 +49,7 @@
     "IPython.sphinxext.ipython_console_highlighting",
     "reno.sphinxext",
     "nbsphinx",
+    "qiskit_sphinx_theme",
 ]
 templates_path = ["_templates"]
 numfig = True
@@ -72,10 +74,5 @@
 nbsphinx_widgets_path = ""
 exclude_patterns = ["_build", "**.ipynb_checkpoints"]
 
-html_theme_options = {
-    "github_user": "qiskit-community",
-    "github_repo": "qiskit-braket-provider",
-    "github_button": True,
-    "github_type": "star",
-    "github_count": False,
-}
+html_theme = "qiskit-ecosystem"
+html_title = f"{project} {release}"
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,6 +2,11 @@
 Qiskit-Braket provider documentation
 ####################################
 
+.. toctree:: 
+  :hidden: 
+
+  Home <self>
+
 Qiskit-Braket provider to execute Qiskit programs on AWS quantum computing hardware devices through Amazon Braket.
 
 API references

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -9,6 +9,7 @@ tox==3.24.5
 jupyter-sphinx>=0.3.2
 nbsphinx>=0.8.8
 sphinx-autodoc-typehints>=1.17.0
+qiskit_sphinx_theme~=1.16.0
 reno>=3.5.0
 # Black's formatting rules can change between major versions, so we use
 # the ~= specifier for it.