Fix typo.

[pyutils.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 7b5287fbe7947a9098cb833fc1455054e619f131..64bbaf8bc38da1def558fbb13db8b46b60341568 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -13,17 +13,17 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('/home/scott/lib/release/pyutils'))
+sys.path.insert(0, os.path.abspath("/home/scott/lib/release/pyutils"))
 sys.path.insert(
-    0, os.path.abspath('/home/scott/py39-venv/lib/python3.9/site-packages/')
+    0, os.path.abspath("/home/scott/py39-venv/lib/python3.9/site-packages/")
 )
-sys.path.insert(0, os.path.abspath('/usr/local/lib/python3.9/site-packages/'))
+sys.path.insert(0, os.path.abspath("/usr/local/lib/python3.9/site-packages/"))
 
 # -- Project information -----------------------------------------------------
 
 project = "pyutils"
-copyright = '2021-2022, Scott Gasch'
-author = 'Scott Gasch'
+copyright = "2021-2022, Scott Gasch"
+author = "Scott Gasch"
 
 
 # -- General configuration ---------------------------------------------------
@@ -32,21 +32,22 @@ author = 'Scott Gasch'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.doctest',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.graphviz",
 ]
 
 autodoc_typehints = "both"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+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']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -54,9 +55,28 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+    "navigation_depth": 5,
+}
 
 # 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']
+html_static_path = ["_static"]
+
+
+# Don't skip __init__()!
+def skip(app, what, name, obj, would_skip, options):
+    return would_skip
+
+
+def setup(app):
+    app.connect("autodoc-skip-member", skip)
+
+
+doctest_global_setup = """
+import pyutils
+"""
+
+autoclass_content = "both"