-
Notifications
You must be signed in to change notification settings - Fork 2
/
conf.py
91 lines (69 loc) · 2.66 KB
/
conf.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
"""Sphinx configuration."""
import datetime
import os
import sys
# -- Path setup --------------------------------------------------------------
sys.path.insert(0, os.path.abspath(".."))
def setup(app):
app.add_css_file("custom.css")
# -- Project information -----------------------------------------------------
project = "glimpse"
author = "Ethan Welty, Douglas Brinkerhoff"
copyright = f"{datetime.datetime.now().year}, {author}"
version = "0.1.0"
# -- Napoleon Extension configuration ------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True
# -- Autodoc configuration -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
autoclass_content = "class"
autodoc_member_order = "bysource"
autodoc_typehints = "description"
# -- Matplotlib configuration -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
plot_include_source = True
plot_html_show_source_link = False
plot_working_directory = ".."
# -- General configuration ---------------------------------------------------
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.doctest",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"matplotlib.sphinxext.plot_directive",
]
doctest_global_setup = """
import glimpse
"""
doctest_test_doctest_blocks = ""
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"numpy": ("http://docs.scipy.org/doc/numpy/", None),
"scipy": ("http://docs.scipy.org/doc/scipy/reference/", None),
"matplotlib": ("http://matplotlib.sourceforge.net/", None),
"piexif": ("https://piexif.readthedocs.io/en/latest/", None),
"sharedmem": ("http://rainwoodman.github.io/sharedmem/", None),
"pyproj": ("http://pyproj4.github.io/pyproj/stable/", None),
}
autosummary_generate = True
templates_path = ["templates"]
# -- Options for HTML output -------------------------------------------------
html_static_path = ["static"]
# https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html
html_theme = "sphinx_rtd_theme"
html_theme_options = {
"style_external_links": False,
"navigation_depth": 4,
}