X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=docs%2Fconf.py;h=64bbaf8bc38da1def558fbb13db8b46b60341568;hb=4f9596f205d9947b5abf93b5295ff623470cf52e;hp=90fa6a7fabbacae59d2a85a2742bcd8130b1b59c;hpb=b38920f24d1ac948958480c540bc4b8436186765;p=pyutils.git diff --git a/docs/conf.py b/docs/conf.py index 90fa6a7..64bbaf8 100644 --- 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,18 +55,19 @@ 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): - if name == "__repr__": - return False return would_skip @@ -73,4 +75,8 @@ def setup(app): app.connect("autodoc-skip-member", skip) -autoclass_content = 'both' +doctest_global_setup = """ +import pyutils +""" + +autoclass_content = "both"