123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869 |
- """Configuration file for the Sphinx documentation builder."""
- # 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
- # TODO: Remove the unneeded.
- project = "dt-evolv"
- release = "0.0.1"
- author = "Daniele Arosio"
- copyright = f"2024, {author}" # noqa: A001
- # -- General configuration ---------------------------------------------------
- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
- extensions = []
- extensions = [
- "sphinx.ext.autodoc",
- "autodocsumm",
- "sphinx.ext.napoleon",
- "sphinx_autodoc_typehints",
- "sphinxcontrib.plantuml",
- "nbsphinx",
- "sphinx_click",
- ]
- # Napoleon settings to Default
- napoleon_use_ivar = False
- # Use __init__ docstring
- napoleon_include_init_with_doc = False
- # Use _private docstring
- napoleon_include_private_with_doc = True
- # Use __special__ docstring
- napoleon_include_special_with_doc = True
- autodoc_default_options = {
- "members": True,
- "member-order": "bysource",
- "undoc-members": False,
- "autosummary": True,
- }
- autodoc_typehints = "description"
- nbsphinx_allow_errors = True
- templates_path = ["_templates"]
- exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
- # To prevent latex hanging on symbols supported by xelatex, but RtD uses latex.
- latex_elements = {
- "papersize": "a4paper",
- "pointsize": "10pt",
- # Additional preamble content
- "preamble": r"""
- \usepackage[utf8]{inputenc}
- \usepackage{newunicodechar}
- \newunicodechar{█}{\rule{1ex}{1ex}}
- """,
- }
- # -- 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"]
|