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.

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 #1822

Merged
merged 2 commits into from
Jun 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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-publish.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: Docs Publish
on:
workflow_dispatch:
push:
tags:
- "*"
Expand Down
16 changes: 3 additions & 13 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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)
68 changes: 0 additions & 68 deletions docs/custom_directives.py

This file was deleted.

2 changes: 1 addition & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 6 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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