Diff of /docs/source/conf.py [000000] .. [061d85]

Switch to unified view

a b/docs/source/conf.py
1
# Configuration file for the Sphinx documentation builder.
2
#
3
# This file only contains a selection of the most common options. For a full
4
# list see the documentation:
5
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6
7
# -- Path setup --------------------------------------------------------------
8
9
# If extensions (or modules to document with autodoc) are in another directory,
10
# add these directories to sys.path here. If the directory is relative to the
11
# documentation root, use os.path.abspath to make it absolute, like shown here.
12
#
13
import os
14
import sys
15
16
sys.path.insert(0, os.path.abspath("../../"))
17
18
19
# -- Project information -----------------------------------------------------
20
21
project = "mowgli"
22
copyright = "2021, Geert-Jan Huizing, Gabriel Peyré, Laura Cantini"
23
author = "Geert-Jan Huizing, Gabriel Peyré, Laura Cantini"
24
25
26
# -- General configuration ---------------------------------------------------
27
28
# Add any Sphinx extension module names here, as strings. They can be
29
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30
# ones.
31
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "nbsphinx"]
32
33
# Add any paths that contain templates here, relative to this directory.
34
templates_path = ["_templates"]
35
36
# List of patterns, relative to source directory, that match files and
37
# directories to ignore when looking for source files.
38
# This pattern also affects html_static_path and html_extra_path.
39
exclude_patterns = []
40
41
42
# -- Options for HTML output -------------------------------------------------
43
44
# The theme to use for HTML and HTML Help pages.  See the documentation for
45
# a list of builtin themes.
46
#
47
html_theme = "furo"
48
# html_theme = 'sphinx_rtd_theme'
49
# html_theme = 'insegel'
50
51
html_title = "Mowgli"
52
# html_short_title = "Mowgli"
53
54
nbsphinx_allow_errors = True
55
56
# Add any paths that contain custom static files (such as style sheets) here,
57
# relative to this directory. They are copied after the builtin static files,
58
# so a file named "default.css" will overwrite the builtin "default.css".
59
html_static_path = ["_static"]
60
61
html_favicon = "_static/favicon.ico"
62
63
html_logo = "_static/logo.png"
64
html_theme_options = {
65
    "sidebar_hide_name": True,
66
}