77 lines
2.4 KiB
Python
77 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
|
|
import pathlib
|
|
import sys
|
|
|
|
import sphinx_rtd_theme
|
|
|
|
sys.path.insert(0, os.path.abspath("../.."))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "osxphotos"
|
|
copyright = "2021, Rhet Turnbull"
|
|
author = "Rhet Turnbull"
|
|
|
|
# holds config info read from disk
|
|
about = {}
|
|
this_directory = pathlib.Path(__file__).parent
|
|
version_file = this_directory.parent.parent / "osxphotos" / "_version.py"
|
|
# get version info from _version
|
|
with open(version_file, mode="r", encoding="utf-8") as f:
|
|
exec(f.read(), about)
|
|
|
|
# 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 = [
|
|
"m2r2",
|
|
"sphinx_click",
|
|
"sphinx_copybutton",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.viewcode",
|
|
"sphinxcontrib.programoutput",
|
|
]
|
|
|
|
# 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.
|
|
#
|
|
# html_theme = "alabaster"
|
|
html_theme = "furo"
|
|
|
|
# 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"]
|