mirror of
https://github.com/enpaul/kodak.git
synced 2024-11-14 10:36:55 +00:00
78 lines
2.7 KiB
Python
78 lines
2.7 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 datetime
|
|
from pathlib import Path
|
|
|
|
BASE_DIR = Path(__file__).parent.resolve()
|
|
ABOUT = {}
|
|
with open(Path(BASE_DIR, "..", "fresnel_lens", "__about__.py")) as infile:
|
|
exec(infile.read(), ABOUT)
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = ABOUT["__title__"]
|
|
copyright = str(datetime.date.today().year)
|
|
author = ", ".join(ABOUT["__authors__"])
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = ABOUT["__version__"]
|
|
|
|
|
|
# -- 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.autodoc",
|
|
"sphinx_autodoc_typehints",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.todo",
|
|
"sphinx.ext.coverage",
|
|
"sphinx.ext.imgmath",
|
|
"sphinx.ext.viewcode",
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = []
|
|
|
|
# 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 = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
master_doc = "index"
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = "alabaster"
|
|
|
|
# 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 = []
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
|
|
# -- Options for intersphinx extension ---------------------------------------
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
intersphinx_mapping = {"https://docs.python.org/": None}
|
|
|
|
# -- Options for todo extension ----------------------------------------------
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
todo_include_todos = True
|