docs/conf.py

   1 # Configuration file for the Sphinx documentation builder.
   2 #
   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
   6
   7 # -- Path setup --------------------------------------------------------------
   8
   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.
  12 #
  13 import os
  14 import sys
  15
  16 sys.path.insert(0, os.path.abspath("/home/scott/lib/release/pyutils"))
  17 sys.path.insert(
  18     0, os.path.abspath("/home/scott/py39-venv/lib/python3.9/site-packages/")
  19 )
  20 sys.path.insert(0, os.path.abspath("/usr/local/lib/python3.9/site-packages/"))
  21
  22 # -- Project information -----------------------------------------------------
  23
  24 project = "pyutils"
  25 copyright = "2021-2022, Scott Gasch"
  26 author = "Scott Gasch"
  27
  28
  29 # -- General configuration ---------------------------------------------------
  30
  31 # Add any Sphinx extension module names here, as strings. They can be
  32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  33 # ones.
  34 extensions = [
  35     "sphinx.ext.autodoc",
  36     "sphinx.ext.doctest",
  37     "sphinx.ext.napoleon",
  38     "sphinx.ext.viewcode",
  39     "sphinx.ext.graphviz",
  40 ]
  41
  42 autodoc_typehints = "both"
  43
  44 # Add any paths that contain templates here, relative to this directory.
  45 templates_path = ["_templates"]
  46
  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"]
  51
  52
  53 # -- Options for HTML output -------------------------------------------------
  54
  55 # The theme to use for HTML and HTML Help pages.  See the documentation for
  56 # a list of builtin themes.
  57 #
  58 html_theme = "sphinx_rtd_theme"
  59 html_theme_options = {
  60     "navigation_depth": 5,
  61 }
  62
  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"]
  67
  68
  69 # Don't skip __init__()!
  70 def skip(app, what, name, obj, would_skip, options):
  71     return would_skip
  72
  73
  74 def setup(app):
  75     app.connect("autodoc-skip-member", skip)
  76
  77
  78 doctest_global_setup = """
  79 import pyutils
  80 """
  81
  82 autoclass_content = "both"