1 # Configuration file for the Sphinx documentation builder.
3 # This file only contains a selection of the most common options. For a full
4 # list see the documentation:
5 # https://www.sphinx-doc.org/en/master/usage/configuration.html
7 # -- Path setup --------------------------------------------------------------
9 # If extensions (or modules to document with autodoc) are in another directory,
10 # add these directories to sys.path here. If the directory is relative to the
11 # documentation root, use os.path.abspath to make it absolute, like shown here.
16 sys.path.insert(0, os.path.abspath('/home/scott/lib/release/pyutils'))
18 0, os.path.abspath('/home/scott/py39-venv/lib/python3.9/site-packages/')
20 sys.path.insert(0, os.path.abspath('/usr/local/lib/python3.9/site-packages/'))
22 # -- Project information -----------------------------------------------------
25 copyright = '2021-2022, Scott Gasch'
26 author = 'Scott Gasch'
29 # -- General configuration ---------------------------------------------------
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
37 'sphinx.ext.napoleon',
38 'sphinx.ext.viewcode',
41 autodoc_typehints = "both"
43 # Add any paths that contain templates here, relative to this directory.
44 templates_path = ['_templates']
46 # List of patterns, relative to source directory, that match files and
47 # directories to ignore when looking for source files.
48 # This pattern also affects html_static_path and html_extra_path.
49 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
52 # -- Options for HTML output -------------------------------------------------
54 # The theme to use for HTML and HTML Help pages. See the documentation for
55 # a list of builtin themes.
57 html_theme = 'sphinx_rtd_theme'
59 # Add any paths that contain custom static files (such as style sheets) here,
60 # relative to this directory. They are copied after the builtin static files,
61 # so a file named "default.css" will overwrite the builtin "default.css".
62 html_static_path = ['_static']