conf.py

# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('..'))


# -- Import Mocking ----------------------------------------------------------

# Mock some dependencies. Sphinx offers the autodoc_mock_imports config
# option for this, but that does not mock for sphinx-click extension.
# This is more global.

import mock

MOCK_MODULES = [
    'apriltag',
    'cv2',
    'flask',
    'gevent',
    'gevent.pywsgi',
    'geventwebsocket',
    'geventwebsocket.exceptions',
    'jsonrpc',
    'jsonrpc.backend',
    'jsonrpc.backend.flask',
    'matplotlib',
    'matplotlib.collections',
    'matplotlib.patches',
    'matplotlib.pyplot',
    'numpy',
    'serial',
    'serial.tools',
    'serial.tools.list_ports',
    'websockets',
]
for mod_name in MOCK_MODULES:
    sys.modules[mod_name] = mock.Mock()


# -- Project information -----------------------------------------------------

project = 'PurpleDrop Driver'
copyright = '2021, University of Washington'
author = 'Jeff McBride'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'myst_parser',
    'sphinx.ext.autodoc',
    'sphinx.ext.autosectionlabel',
    'sphinx.ext.napoleon',
    'sphinx_rtd_theme',
    'sphinx.ext.viewcode',
    'sphinx_click',
]

# Suppress duplicate label warnings
suppress_warnings = ['autosectionlabel.*']

# Add any paths that contain templates here, relative to this directory.
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']


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'

# 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']