Skip to content
Snippets Groups Projects
conf.py 2.03 KiB
Newer Older
Tamas Gal's avatar
Tamas Gal committed
# 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('.'))


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

project = 'km3io'
Tamas Gal's avatar
Tamas Gal committed
copyright = '2019, Zineb Aly and Tamas Gal'
author = 'Zineb Aly, Tamas Gal'
Tamas Gal's avatar
Tamas Gal committed


# -- 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 = [
Tamas Gal's avatar
Tamas Gal committed
        'sphinx.ext.autodoc',
        'sphinx.ext.autosummary',
        'sphinx.ext.viewcode',
        'autoapi.extension',
        'numpydoc'
Tamas Gal's avatar
Tamas Gal committed
]

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

Tamas Gal's avatar
Tamas Gal committed
# AutoAPI
autoapi_type = 'python'
autoapi_dirs = ['../km3io']

Tamas Gal's avatar
Tamas Gal committed

# -- 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 = 'alabaster'

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