Use Qiskit theme in docs (#757)

* publish-docs

* Switch which workflow triggers docs uploads

* use qiskit theme

* switch import location
This commit is contained in:
Caleb Johnson 2023-07-10 18:58:31 -05:00 committed by GitHub
parent 5667c13c4c
commit 830191753e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 10 additions and 12 deletions

View File

@ -20,3 +20,9 @@ jobs:
- name: Build docs
run: |
tox -edocs
- name: Upload docs artifact
if: always()
uses: actions/upload-artifact@v3
with:
name: html_docs
path: ./docs/_build/html/

View File

@ -32,6 +32,7 @@ extensions = [
"reno.sphinxext",
"nbsphinx",
"sphinx_copybutton",
"qiskit_sphinx_theme",
]
templates_path = ["_templates"]
numfig = True
@ -42,17 +43,7 @@ add_module_names = False
modindex_common_prefix = ["quantum_serverless_project."]
# html theme options
html_theme_options = {
'github_button': True,
'github_user': 'Qiskit-Extensions',
'github_repo': 'quantum-serverless',
'github_type': 'star',
'github_count': False,
'extra_nav_links': {
'Repository': 'https://github.com/Qiskit-Extensions/quantum-serverless',
'Report issues': 'https://github.com/Qiskit-Extensions/quantum-serverless/issues/new?assignees=&labels=bug&template=bug_report.md'
}
}
html_theme = "qiskit"
# autodoc/autosummary options
autosummary_generate = True

View File

@ -17,6 +17,7 @@ ray==2.5.0
qiskit-terra==0.21.1
qiskit-ibm-runtime==0.7.0rc2
sphinx-copybutton>=0.5.2
qiskit-sphinx-theme~=1.13.0rc2
redis>=4.3.4
# opentelemetry
opentelemetry-api>=1.15.0

View File

@ -13,4 +13,4 @@ setenv =
deps =
-r ./docs/requirements-doc.txt
commands =
sphinx-build -v -b html -W {posargs} docs/ docs/_build/html
sphinx-build -v -W {posargs} docs/ docs/_build/html