mirror of
https://github.com/samsledje/D-SCRIPT.git
synced 2026-06-05 23:54:21 +08:00
80 lines
2.4 KiB
Python
80 lines
2.4 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- 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.path
|
|
import sys
|
|
from importlib.metadata import version as _get_version
|
|
|
|
sys.path.insert(0, os.path.abspath("."))
|
|
sys.path.insert(0, os.path.abspath("../"))
|
|
sys.path.insert(0, os.path.abspath("../../"))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "D-SCRIPT"
|
|
copyright = "2025, Samuel Sledzieski"
|
|
author = "Samuel Sledzieski"
|
|
|
|
release = _get_version("dscript")
|
|
master_doc = "index"
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
"sphinx.ext.todo",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.mathjax",
|
|
]
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
|
|
|
|
# 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 = []
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ["_static"]
|
|
html_css_files = [
|
|
"css/dscript.css",
|
|
]
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
# html_theme = 'default'
|
|
# html_theme = "sphinx_rtd_theme"
|
|
html_theme = "pydata_sphinx_theme"
|
|
html_theme_options = {
|
|
"navbar_end": ["theme-switcher"],
|
|
"logo": {
|
|
"text": "D-SCRIPT",
|
|
},
|
|
}
|
|
# html_logo = '_static/dscript_architecture1.png'
|
|
html_context = {"default_mode": "auto"}
|
|
html_sidebars = {"**": []}
|