aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/config.py
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/config.py')
-rw-r--r--docs/source/config.py24
1 files changed, 13 insertions, 11 deletions
diff --git a/docs/source/config.py b/docs/source/config.py
index fa4794e..83c0158 100644
--- a/docs/source/config.py
+++ b/docs/source/config.py
@@ -10,9 +10,11 @@ if sys.version_info >= (3, 11):
else:
import tomli as tomllib
+
def setup(app):
- app.add_config_value('releaselevel', '', 'env')
-
+ app.add_config_value("releaselevel", "", "env")
+
+
DATA = None
PYPROJECT = os.path.join("..", "..", "Cargo.toml")
with open(PYPROJECT, "r", encoding="utf8") as f:
@@ -55,17 +57,17 @@ extensions = [
"myst_parser",
]
-doctest_global_setup = '''
+doctest_global_setup = """
try:
import hydro_roll as hr
import hydro_roll_core as hrc
except ImportError:
hr = None
hrc = None
-'''
+"""
todo_include_todos = True
todo_emit_warnings = True
-intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
extlinks = {
@@ -90,13 +92,13 @@ rst_epilog = """
locale_dirs = ["../locales/"] # path is example but recommended.
gettext_compact = False # optional.
gettext_uuid = True # optional.
-numfig = True # Figures, tables and code blocks are automatically numbered if they have a title
-pygments_style = "rrt" # default sphinx, change the style of code block
-math_number_all = True # Number all equations, figures, tables and code blocks
+numfig = True # Figures, tables and code blocks are automatically numbered if they have a title
+pygments_style = "rrt" # default sphinx, change the style of code block
+math_number_all = True # Number all equations, figures, tables and code blocks
html_additional_pages = {
- 'copy': 'copying.html',
+ "copy": "copying.html",
}
-html_split_index = True # Split the index page by each alphabet
+html_split_index = True # Split the index page by each alphabet
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
@@ -146,4 +148,4 @@ html_theme_options = {
# html_sidebars = {
# '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html', 'relations.html'],
# 'using/windows': ['windowssidebar.html', 'searchbox.html'],
-# } \ No newline at end of file
+# }