-
Notifications
You must be signed in to change notification settings - Fork 204
/
conf.py
200 lines (160 loc) · 6.89 KB
/
conf.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# This code is part of a Qiskit project.
#
# (C) Copyright IBM 2021, 2024.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE.txt file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.
# pylint: disable=invalid-name
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# 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
from datetime import date
sys.path.insert(0, os.path.abspath(".."))
sys.path.append(os.path.abspath("."))
import qiskit_nature
# 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"
# -- Project information -----------------------------------------------------
project = "Qiskit Nature"
copyright = f"2018, {date.today().year}, Qiskit Nature Development Team" # pylint: disable=redefined-builtin
author = "Qiskit Nature Development Team"
docs_url_prefix = "qiskit-nature"
# The short X.Y version
version = qiskit_nature.__version__
# The full version, including alpha/beta/rc tags
release = qiskit_nature.__version__
rst_prolog = """
.. raw:: html
<br><br><br>
.. |version| replace:: {0}
""".format(
release
)
nbsphinx_prolog = """
{% set docname = env.doc2path(env.docname, base=None) %}
.. only:: html
.. role:: raw-html(raw)
:format: html
.. note::
This page was generated from `docs/{{ docname }}`__.
__"""
vers = version.split(".")
link_str = (
f" https://github.com/qiskit-community/qiskit-nature/blob/stable/{vers[0]}.{vers[1]}/docs/"
)
nbsphinx_prolog += link_str + "{{ docname }}"
# -- General configuration ---------------------------------------------------
extensions = [
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"sphinx.ext.extlinks",
"sphinx_design",
"jupyter_sphinx",
"reno.sphinxext",
"sphinx.ext.doctest",
"nbsphinx",
"sphinx.ext.intersphinx",
"qiskit_sphinx_theme",
"matplotlib.sphinxext.plot_directive",
]
html_static_path = ["_static"]
templates_path = ["_templates"]
nbsphinx_timeout = 360
nbsphinx_execute = os.getenv("QISKIT_DOCS_BUILD_TUTORIALS", "never")
nbsphinx_widgets_path = ""
nbsphinx_thumbnails = {
"migration/0.5_a_intro": "_images/qiskit_nature_0.5_overview.png",
"migration/0.5_c_electronic_structure": "_static/orbitals.png",
"migration/0.5_d_vibrational_structure": "_static/co2_vibration.png",
"migration/0.5_e_lattice_models": "_images/tutorials_10_lattice_models_18_0.png",
"migration/0.5_f_protein_folding": "_static/lattice_protein.png",
"tutorials/01_electronic_structure": "_static/orbitals.png",
"tutorials/02_vibrational_structure": "_static/co2_vibration.png",
"tutorials/03_ground_state_solvers": "_images/H2_gs.png",
"tutorials/04_excited_states_solvers": "_images/H2_es.png",
"tutorials/05_problem_transformers": "_static/core-orbitals.png",
"tutorials/06_qubit_mappers": "_images/jw_mapping.png",
"tutorials/07_leveraging_qiskit_runtime": "_static/runtime.png",
"**": "_static/images/logo.png",
}
spelling_word_list_filename = "../.pylintdict"
spelling_filters = ["lowercase_filter.LowercaseFilter"]
# -----------------------------------------------------------------------------
# Autosummary
# -----------------------------------------------------------------------------
autosummary_generate = True
autosummary_generate_overwrite = False
# -----------------------------------------------------------------------------
# Autodoc
# -----------------------------------------------------------------------------
# Move type hints from signatures to the parameter descriptions (except in overload cases, where
# that's not possible).
autodoc_typehints = "description"
# Only add type hints from signature to description body if the parameter has documentation. The
# return type is always added to the description (if in the signature).
autodoc_typehints_description_target = "documented_params"
autodoc_default_options = {
"inherited-members": None,
}
autoclass_content = "both"
# If true, figures, tables and code-blocks are automatically numbered if they
# have a caption.
numfig = True
# A dictionary mapping 'figure', 'table', 'code-block' and 'section' to
# strings that are used for format of figure numbers. As a special character,
# %s will be replaced to figure number.
numfig_format = {"table": "Table %s"}
translations_list = [
("en", "English"),
("ja_JP", "Japanese"),
("es_UN", "Spanish"),
]
language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["**site-packages", "_build", "**.ipynb_checkpoints"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "colorful"
# A boolean that decides whether module names are prepended to all object names
# (for object types where a “module” of some kind is defined), e.g. for
# py:function directives.
add_module_names = False
# A list of prefixes that are ignored for sorting the Python module index
# (e.g., if this is set to ['foo.'], then foo.bar is shown under B, not F).
# This can be handy if you document a project that consists of a single
# package. Works only for the HTML builder currently.
modindex_common_prefix = ["qiskit_nature."]
# -- Configuration for extlinks extension ------------------------------------
# Refer to https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
# -- Options for HTML output -------------------------------------------------
html_theme = "qiskit-ecosystem"
html_title = f"{project} {release}"
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
"qiskit": ("https://docs.quantum.ibm.com/api/qiskit/", None),
"qiskit-algorithms": ("https://qiskit-community.github.io/qiskit-algorithms/", None),
"rustworkx": ("https://www.rustworkx.org/", None),
"sparse": ("https://sparse.pydata.org/en/stable/", None),
}
html_context = {"analytics_enabled": True}