Upgrade to qiskit_sphinx_theme 1.12 (Qiskit#880)

* Upgrade to qiskit_sphinx_theme 1.12 * Fix static path option
IvanIsCoding · May 26, 2023 · 866b67f · 866b67f
1 parent c001c31
commit 866b67f
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 106 deletions.
diff --git a/.github/workflows/docs_dev.yml b/.github/workflows/docs_dev.yml
@@ -1,5 +1,6 @@
 name: Docs Publish
 on:
+  workflow_dispatch:
   push:
     branches: [ main ]
 

diff --git a/docs/source/_static/overrides.css b/docs/source/_static/overrides.css
@@ -0,0 +1,3 @@
+:root {
+  --header-height: 0rem;
+}
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
@@ -156,13 +156,9 @@
       {{ js_tag(scriptfile) }}
     {%- endfor %}
 
-    <script type="text/javascript" src="{{ pathto('_static/js/vendor/popper.min.js', 1) }}"></script>
-    <script type="text/javascript" src="{{ pathto('_static/js/vendor/bootstrap.min.js', 1) }}"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/list.js/1.5.0/list.min.js"></script>
     <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
 
-  <script type="text/javascript" src="{{ pathto('_static/js/vendor/anchor.min.js', 1) }}"></script>
-
   <!-- enable language dropdown menu expand -->
   <script type="text/javascript">
     jQuery(function () {

diff --git a/docs/source/_templates/sidebar.html b/docs/source/_templates/sidebar.html
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,7 +21,7 @@
 
 project = 'rustworkx'
 copyright = '2021, rustworkx Contributors'
-
+docs_url_prefix = "ecosystem/rustworkx"
 
 # The short X.Y version.
 version = '0.13.0'
@@ -42,7 +42,9 @@
               'sphinx_reredirects',
               'qiskit_sphinx_theme',
              ]
+html_static_path = ["_static"]
 templates_path = ['_templates']
+extra_css_files = ["overrides.css"]
 
 pygments_style = 'colorful'
 

diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -1,10 +1,10 @@
 m2r2
-sphinx>=3.0.0
+sphinx>=5.0
 jupyter-sphinx
 pydot
 pillow>=4.2.1
 reno>=3.4.0
-qiskit-sphinx-theme~=1.11.1
+qiskit-sphinx-theme~=1.12.0
 matplotlib>=3.4
 sphinx-reredirects
 sphinxemoji

diff --git a/tox.ini b/tox.ini
@@ -60,6 +60,12 @@ commands =
   jupyter kernelspec list
   sphinx-build -W -d {toxinidir}/docs/build/.doctrees -b html source build/html {posargs}
 
+[testenv:docs-clean]
+skip_install = true
+deps =
+allowlist_externals = rm
+commands = rm -rf {toxinidir}/docs/build {toxinidir}/docs/apiref
+
 [testenv:black]
 basepython = python3
 deps =