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/python_modules'))
  17 sys.path.insert(0, os.path.abspath('../..'))
  18 sys.path.insert(0, os.path.abspath('../../cached'))
  19 sys.path.insert(0, os.path.abspath('../../collect'))
  20 sys.path.insert(0, os.path.abspath('../../dateparse'))
  21 sys.path.insert(0, os.path.abspath('../../ml'))
  22 sys.path.insert(0, os.path.abspath('../../music'))
  23 sys.path.insert(0, os.path.abspath('../../smart_home'))
  24 sys.path.insert(0, os.path.abspath('../../tests'))
  25 sys.path.insert(0, os.path.abspath('../../type'))
  26 sys.path.insert(0, os.path.abspath('/home/scott/py38-venv/lib/python3.8/site-packages/'))
  27 sys.path.insert(0, os.path.abspath('/usr/local/lib/python3.8/site-packages/'))
  28
  29 # -- Project information -----------------------------------------------------
  30
  31 project = "Scott's Python Utils"
  32 copyright = '2022, Scott Gasch'
  33 author = 'Scott Gasch'
  34
  35
  36 # -- General configuration ---------------------------------------------------
  37
  38 # Add any Sphinx extension module names here, as strings. They can be
  39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  40 # ones.
  41 extensions = [
  42     'sphinx.ext.autodoc',
  43     'sphinx.ext.doctest',
  44     'sphinx.ext.napoleon',
  45     'sphinx.ext.viewcode',
  46 ]
  47
  48 autodoc_typehints = "both"
  49
  50 # Add any paths that contain templates here, relative to this directory.
  51 templates_path = ['_templates']
  52
  53 # List of patterns, relative to source directory, that match files and
  54 # directories to ignore when looking for source files.
  55 # This pattern also affects html_static_path and html_extra_path.
  56 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  57
  58
  59 # -- Options for HTML output -------------------------------------------------
  60
  61 # The theme to use for HTML and HTML Help pages.  See the documentation for
  62 # a list of builtin themes.
  63 #
  64 html_theme = 'sphinx_rtd_theme'
  65
  66 # Add any paths that contain custom static files (such as style sheets) here,
  67 # relative to this directory. They are copied after the builtin static files,
  68 # so a file named "default.css" will overwrite the builtin "default.css".
  69 html_static_path = ['_static']