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 ]
  40
  41 autodoc_typehints = "both"
  42
  43 # Add any paths that contain templates here, relative to this directory.
  44 templates_path = ['_templates']
  45
  46 # List of patterns, relative to source directory, that match files and
  47 # directories to ignore when looking for source files.
  48 # This pattern also affects html_static_path and html_extra_path.
  49 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  50
  51
  52 # -- Options for HTML output -------------------------------------------------
  53
  54 # The theme to use for HTML and HTML Help pages.  See the documentation for
  55 # a list of builtin themes.
  56 #
  57 html_theme = 'sphinx_rtd_theme'
  58
  59 # Add any paths that contain custom static files (such as style sheets) here,
  60 # relative to this directory. They are copied after the builtin static files,
  61 # so a file named "default.css" will overwrite the builtin "default.css".
  62 html_static_path = ['_static']