Upgrade to qiskit_sphinx_theme 1.12 (#1822)

.github/workflows/docs-publish.yml

@@ -1,5 +1,6 @@
 name: Docs Publish
 on:
+  workflow_dispatch:
   push:
     tags:
       - "*"

docs/conf.py

@@ -25,9 +25,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import os
-import sys
-sys.path.insert(0, os.path.abspath('.'))
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
 
 """
 Sphinx documentation builder
@@ -38,18 +38,12 @@
 # Set env flag so that we can doc functions that may otherwise not be loaded
 # see for example interactive visualizations in qiskit.visualization.
 os.environ['QISKIT_DOCS'] = 'TRUE'
-sys.path.insert(0, os.path.abspath('.'))
 
 # -- Project information -----------------------------------------------------
 project = 'Qiskit Aer'
 copyright = f"2017-{datetime.date.today().year}, Qiskit Development Team"  # pylint: disable=redefined-builtin
 author = 'Qiskit Development Team'
 
-import qiskit_sphinx_theme
-from custom_directives import (
-    CustomCalloutItemDirective
-)
-
 # The short X.Y version
 version = '0.13.0'
 # The full version, including alpha/beta/rc tags
@@ -162,7 +156,3 @@
     "matplotlib": ("https://matplotlib.org/stable/", None),
     "qiskit": ("https://qiskit.org/documentation/", None),
 }
-
-# -- Extension configuration -------------------------------------------------
-def setup(app):
-    app.add_directive("customcalloutitem", CustomCalloutItemDirective)

docs/getting_started.rst

@@ -193,7 +193,7 @@ Ready to get going?...
    <div class="tutorials-callout-container">
       <div class="row">
 
-.. customcalloutitem::
+.. qiskit-call-to-action-item::
    :description: Find out about Qiskit Aer
    :header: Dive into the tutorials
    :button_link:  ./tutorials/index.html

requirements-dev.txt

@@ -13,6 +13,6 @@ reno>=3.4.0
 ddt>=1.2.0,!=1.4.0
 matplotlib>=3.3
 seaborn>=0.9.0
-qiskit_sphinx_theme>=1.10
+qiskit_sphinx_theme~=1.12.0
 sphinx-design>=0.2.0
 nbsphinx

tox.ini

@@ -54,3 +54,9 @@ commands =
   python -I -m build --wheel -C=--build-option=-- -C=--build-option=-- -C=--build-option=-j4
   pip install --find-links={toxinidir}/dist qiskit_aer
   sphinx-build -W -b html docs/ docs/_build/html -j auto {posargs}
+
+[testenv:docs-clean]
+skip_install = true
+deps =
+allowlist_externals = rm
+commands = rm -rf {toxinidir}/docs/stubs/ {toxinidir}/docs/_build