mirror of
https://github.com/ivan-usov-org/bec.git
synced 2025-04-21 02:10:01 +02:00
50 lines
1.9 KiB
Python
50 lines
1.9 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
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = "BEC"
|
|
copyright = "2022, Klaus Wakonig"
|
|
author = "Klaus Wakonig"
|
|
release = "0.1"
|
|
|
|
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../..")))
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = extensions = [
|
|
"sphinx.ext.todo",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.coverage",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.autosummary",
|
|
]
|
|
autosummary_generate = True # Turn on sphinx.ext.autosummary
|
|
autoclass_content = "both" # Add __init__ doc (ie. params) to class summaries
|
|
html_show_sourcelink = False # Remove 'view source code' from top of page (for html, not python)
|
|
autodoc_inherit_docstrings = True # If no docstring, inherit from base class
|
|
set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints
|
|
nbsphinx_allow_errors = True # Continue through Jupyter errors
|
|
# autodoc_typehints = "description" # Sphinx-native method. Not as good as sphinx_autodoc_typehints
|
|
add_module_names = False # Remove namespaces from class/method signatures
|
|
|
|
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 = 'alabaster'
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_static_path = ["_static"]
|