# 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('.')) sys.path.insert(1, os.path.dirname(os.path.abspath('.'))) sys.path.insert(2, os.path.join(os.path.dirname(os.path.abspath('.')), "actions")) sys.path.insert(3, os.path.join(os.path.dirname(os.path.abspath('.')), "plugins")) # Hack so the HTTP plugin will import sys.path.insert(4, os.path.join(os.path.dirname(os.path.abspath('.')), "plugins", "http")) import sphinx_rtd_theme # -- Project information ----------------------------------------------------- project = 'geneva' copyright = '2020, Kevin Bock' author = 'Kevin Bock' # -- 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 = [ "sphinx_rtd_theme", "sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx.ext.autosectionlabel" ] master_doc = 'index' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] autodoc_member_order = 'groupwise' # Don't skip __init__ def skip(app, what, name, obj, would_skip, options): if name == "__init__": return False return would_skip def setup(app): app.connect("autodoc-skip-member", skip) # 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'] pygments_style = 'colorful' # -- 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'] html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] }