66 lines
1.5 KiB
Python
66 lines
1.5 KiB
Python
"""
|
|
Sphinx documentation builder
|
|
"""
|
|
|
|
# General options:
|
|
import os
|
|
import sys
|
|
from pathlib import Path
|
|
from importlib.metadata import version as metadata_version
|
|
|
|
sys.path.append(os.path.abspath("../client"))
|
|
|
|
project = "Qiskit Serverless"
|
|
copyright = "2022" # pylint: disable=redefined-builtin
|
|
author = ""
|
|
|
|
_rootdir = Path(__file__).parent.parent
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = metadata_version("qiskit_serverless")
|
|
|
|
# The X.Y.Z version
|
|
version = ".".join(release.split(".")[:3])
|
|
|
|
extensions = [
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx.ext.mathjax",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.extlinks",
|
|
"jupyter_sphinx",
|
|
"sphinx_autodoc_typehints",
|
|
"reno.sphinxext",
|
|
"nbsphinx",
|
|
"sphinx_copybutton",
|
|
"qiskit_sphinx_theme",
|
|
]
|
|
templates_path = ["_templates"]
|
|
numfig = False
|
|
numfig_format = {"table": "Table %s"}
|
|
language = "en"
|
|
pygments_style = "colorful"
|
|
add_module_names = False
|
|
modindex_common_prefix = ["qiskit_serverless_project."]
|
|
|
|
# html theme options
|
|
html_theme = "qiskit-ecosystem"
|
|
html_title = f"{project} {release}"
|
|
html_theme_options = {
|
|
"dark_logo": "images/qiskit-dark-logo.svg",
|
|
"light_logo": "images/qiskit-light-logo.svg",
|
|
}
|
|
html_static_path = ["_static"]
|
|
|
|
# autodoc/autosummary options
|
|
autosummary_generate = True
|
|
autosummary_generate_overwrite = False
|
|
autoclass_content = "both"
|
|
|
|
# nbsphinx options (for tutorials)
|
|
nbsphinx_timeout = 180
|
|
nbsphinx_execute = "never"
|
|
nbsphinx_widgets_path = ""
|
|
exclude_patterns = ["_build", "**.ipynb_checkpoints"]
|