Source code for conf

# 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:
# http://www.sphinx-doc.org/en/master/config

# -- 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('.'))


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

[docs]project = 'heiMPT'
[docs]copyright = '2019, Dulip Withanage'
[docs]author = 'Dulip Withanage'

# The full version, including alpha/beta/rc tags
[docs]release = '1.0.0'


# -- 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.

[docs]extensions = ['sphinx.ext.viewcode','sphinx.ext.autodoc']
extensions.append('autoapi.extension')

# Document Python Code
[docs]autodoc_mock_imports = ["heimpt.tools.archive"]
[docs]autoapi_type = 'python'
[docs]autoapi_dirs = ['../']


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


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

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
[docs]html_theme = 'classic' # use the theme in subdir 'theme'
[docs]html_theme_path = ['.'] # make sphinx search for themes in current dir


# 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".
[docs]html_static_path = ['_static']