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",
39 "sphinx.ext.graphviz",
42 autodoc_typehints = "both"
44 # Add any paths that contain templates here, relative to this directory.
45 templates_path = ["_templates"]
47 # List of patterns, relative to source directory, that match files and
48 # directories to ignore when looking for source files.
49 # This pattern also affects html_static_path and html_extra_path.
50 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
53 # -- Options for HTML output -------------------------------------------------
55 # The theme to use for HTML and HTML Help pages. See the documentation for
56 # a list of builtin themes.
58 html_theme = "sphinx_rtd_theme"
59 html_theme_options = {
60 "navigation_depth": 5,
63 # Add any paths that contain custom static files (such as style sheets) here,
64 # relative to this directory. They are copied after the builtin static files,
65 # so a file named "default.css" will overwrite the builtin "default.css".
66 html_static_path = ["_static"]
69 # Don't skip __init__()!
70 def skip(app, what, name, obj, would_skip, options):
75 app.connect("autodoc-skip-member", skip)
78 doctest_global_setup = """
82 autoclass_content = "both"