mirror of
https://github.com/ivan-usov-org/bec.git
synced 2025-04-21 10:10:02 +02:00
80 lines
2.3 KiB
Python
80 lines
2.3 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
import datetime
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
import os
|
|
import pathlib
|
|
|
|
project = "BEC"
|
|
copyright = f"{datetime.datetime.today().year}, Paul Scherrer Institute, Switzerland"
|
|
author = "Klaus Wakonig"
|
|
|
|
current_path = pathlib.Path(__file__).parent.parent.parent.resolve()
|
|
version_path = f"{current_path}/semantic_release/"
|
|
|
|
|
|
def get_version():
|
|
"""load the version from the version file"""
|
|
version_file = os.path.join(version_path, "__init__.py")
|
|
with open(version_file, "r", encoding="utf-8") as file:
|
|
res = file.readline()
|
|
version = res.split("=")[1]
|
|
return version.strip().strip('"')
|
|
|
|
|
|
release = get_version()
|
|
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.autosummary",
|
|
# "sphinx.ext.coverage",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx_toolbox.collapse",
|
|
"sphinx_copybutton",
|
|
"myst_parser",
|
|
"sphinx_design",
|
|
]
|
|
|
|
myst_enable_extensions = [
|
|
"amsmath",
|
|
"attrs_inline",
|
|
"colon_fence",
|
|
"deflist",
|
|
"dollarmath",
|
|
"fieldlist",
|
|
"html_admonition",
|
|
"html_image",
|
|
"replacements",
|
|
"smartquotes",
|
|
"strikethrough",
|
|
"substitution",
|
|
"tasklist",
|
|
]
|
|
|
|
autosummary_generate = True # Turn on sphinx.ext.autosummary
|
|
add_module_names = False # Remove namespaces from class/method signatures
|
|
autodoc_inherit_docstrings = True # If no docstring, inherit from base class
|
|
set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints
|
|
autoclass_content = "both" # Include both class docstring and __init__
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
language = "Python"
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "pydata_sphinx_theme"
|
|
html_static_path = ["_static"]
|
|
html_css_files = ["css/custom.css"]
|
|
html_logo = "_static/bec.png"
|