-
Notifications
You must be signed in to change notification settings - Fork 64
Expand file tree
/
Copy pathconf.py
More file actions
63 lines (49 loc) · 1.88 KB
/
conf.py
File metadata and controls
63 lines (49 loc) · 1.88 KB
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
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import fastplotlib
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "fastplotlib"
copyright = "2023, Kushal Kolar, Caitlin Lewis"
author = "Kushal Kolar, Caitlin Lewis"
release = fastplotlib.__version__
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx_copybutton",
"sphinx_design",
"nbsphinx",
]
autosummary_generate = True
templates_path = ["_templates"]
exclude_patterns = []
napoleon_custom_sections = ["Features"]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "furo"
html_static_path = ["_static"]
html_logo = "_static/logo.png"
html_title = f"v{release}"
autodoc_member_order = "groupwise"
autoclass_content = "both"
add_module_names = False
autodoc_typehints = "description"
autodoc_typehints_description_target = "documented_params"
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"pygfx": ("https://pygfx.readthedocs.io/en/latest", None),
"wgpu": ("https://wgpu-py.readthedocs.io/en/latest", None),
}
html_theme_options = {
"source_repository": "https://github.com/kushalkolar/fastplotlib",
"source_branch": "main",
"source_directory": "docs/",
}