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

Upgrade to qiskit_sphinx_theme 1.12 #224

Merged
merged 2 commits into from
Jun 1, 2023
Merged

Upgrade to qiskit_sphinx_theme 1.12 #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2805267
Upgrade to qiskit_sphinx_theme 1.12
Eric-Arellano May 24, 2023
e134820
Merge branch 'main' into upgrade-to-theme-12
DanPuzzuoli Jun 1, 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
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: Docs Publish
on:
workflow_dispatch:
push:
tags:
- "*"
Expand Down
6 changes: 1 addition & 5 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@

# pylint: disable=invalid-name

"""
Sphinx documentation builder
"""

# General options:

project = 'Qiskit Dynamics'
Expand All @@ -40,7 +36,7 @@
'sphinx.ext.intersphinx',
'nbsphinx',
'sphinxcontrib.bibtex',
"sphinxcontrib.jquery", # Remove when changing html_theme to qiskit_ecosystem.
"qiskit_sphinx_theme",
Comment on lines -43 to +39
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will still activate jQuery. It's more future-proof because qiskit_sphinx_theme now has some functionality like optionally supporting Translations.

]
templates_path = ["_templates"]

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 @@ -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
Expand Down
9 changes: 6 additions & 3 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,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
Comment on lines -50 to -51
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unused

[testenv:docs-clean]
skip_install = true
deps =
allowlist_externals = rm
commands = rm -rf {toxinidir}/docs/stubs/ {toxinidir}/docs/_build