conf.py 2.18 KB
Newer Older
TiG's avatar
TiG committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# 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('.'))
TiG's avatar
TiG committed
16
import sphinx_rtd_theme
TiG's avatar
TiG committed
17
18
19

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

Bengfort's avatar
Bengfort committed
20
project = 'Castellum'
TiG's avatar
TiG committed
21
22
copyright = '2018-2021, Max Planck Institute for Human Development'
author = 'Max Planck Institute for Human Development'
TiG's avatar
TiG committed
23
24

# The full version, including alpha/beta/rc tags
Bengfort's avatar
Bengfort committed
25
version = '0.66'
TiG's avatar
TiG committed
26
27
28
29
30
31
32
33


# -- 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 = [
TiG's avatar
TiG committed
34
    'sphinx_rtd_theme',
Bengfort's avatar
Bengfort committed
35
    'sphinx.ext.todo',
TiG's avatar
TiG committed
36
37
]

Bengfort's avatar
Bengfort committed
38
39
todo_include_todos = True

TiG's avatar
TiG committed
40
41
42
43
44
45
46
47
# 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 = []

TiG's avatar
TiG committed
48
49
50
51
52
# -- Options i18n -------------------------------------------------

language = 'en'
locale_dirs = ['locale/']   # path is example but recommended.
gettext_compact = False     # optional.
TiG's avatar
TiG committed
53
54
55

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

TiG's avatar
TiG committed
56
html_theme = 'sphinx_rtd_theme'
TiG's avatar
TiG committed
57
58
59
60

# 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".
TiG's avatar
TiG committed
61
62
63
64
html_static_path = ['_static']

html_js_files = [
    'js/switchLanguage.js'
Bengfort's avatar
Bengfort committed
65
66
67
68
]

html_css_files = [
    'custom.css',
TiG's avatar
TiG committed
69
]