From 2805267111212d10151483a27c4a21159438e120 Mon Sep 17 00:00:00 2001 From: Eric Arellano Date: Wed, 24 May 2023 08:29:20 -0600 Subject: [PATCH] Upgrade to qiskit_sphinx_theme 1.12 --- .github/workflows/docs.yml | 1 + docs/conf.py | 6 +----- requirements-dev.txt | 2 +- tox.ini | 9 ++++++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ad99f9030..4490fce6a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,5 +1,6 @@ name: Docs Publish on: + workflow_dispatch: push: tags: - "*" diff --git a/docs/conf.py b/docs/conf.py index 507de5bee..33d3383af 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,10 +12,6 @@ # pylint: disable=invalid-name -""" -Sphinx documentation builder -""" - # General options: project = 'Qiskit Dynamics' @@ -40,7 +36,7 @@ 'sphinx.ext.intersphinx', 'nbsphinx', 'sphinxcontrib.bibtex', - "sphinxcontrib.jquery", # Remove when changing html_theme to qiskit_ecosystem. + "qiskit_sphinx_theme", ] templates_path = ["_templates"] diff --git a/requirements-dev.txt b/requirements-dev.txt index 1c2d40ed6..a1aa26bf7 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -2,7 +2,7 @@ stestr>=3.0.0 astroid==2.9.3 pylint==2.12.2 black~=22.0 -qiskit-sphinx-theme~=1.11 +qiskit-sphinx-theme~=1.12.0 sphinx-autodoc-typehints jupyter-sphinx pygments>=2.4 diff --git a/tox.ini b/tox.ini index 5c642eac7..405a680e2 100644 --- a/tox.ini +++ b/tox.ini @@ -43,7 +43,10 @@ deps = jaxlib<=0.4.6 diffrax commands = - sphinx-build -b html -W {posargs} docs/ docs/_build/html + sphinx-build -j auto -b html -W {posargs} docs/ docs/_build/html -[pycodestyle] -max-line-length = 100 +[testenv:docs-clean] +skip_install = true +deps = +allowlist_externals = rm +commands = rm -rf {toxinidir}/docs/stubs/ {toxinidir}/docs/_build