smbmc/docs/conf.py

61 lines
2 KiB
Python
Raw Normal View History

2020-11-19 18:53:28 +00:00
"""Configuration file for the Sphinx documentation builder."""
2020-10-31 16:57:30 +00:00
# -- 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
import sys
try:
import importlib.metadata as metadata
except ImportError:
import importlib_metadata as metadata
from datetime import datetime
sys.path.insert(0, os.path.abspath(".."))
sys.path.insert(0, os.path.abspath("."))
# -- Project information -----------------------------------------------------
project = "smbmc"
author = "George Rawlinson"
copyright = f"{datetime.now().year}, {author}"
version = metadata.version(project)
release = 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.ext.napoleon",
2020-11-19 18:53:28 +00:00
"sphinx_rtd_theme",
2020-10-31 16:57:30 +00:00
]
# 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 = ["_build", "Thumbs.db", ".DS_Store"]
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
2020-11-19 18:53:28 +00:00
html_theme = "sphinx_rtd_theme"
2020-10-31 16:57:30 +00:00
# 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"]