-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathconf.py
More file actions
79 lines (64 loc) · 1.75 KB
/
conf.py
File metadata and controls
79 lines (64 loc) · 1.75 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# Configuration file for the Sphinx documentation builder.
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import os
import sys
sys.path.insert(0, os.path.abspath("../src/"))
# -- Project information -------------------------------------------------------
project = "openpois"
copyright = "2026, Nathaniel Henry"
author = "Nathaniel Henry"
release = "1.0.0"
# -- General configuration -----------------------------------------------------
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
"sphinx.ext.intersphinx",
]
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# Mock heavy imports so Sphinx can parse docstrings without installing the
# full conda environment in CI.
autodoc_mock_imports = [
"jax",
"jaxlib",
"blackjax",
"numpy",
"pandas",
"geopandas",
"shapely",
"fiona",
"pyosmium",
"osmium",
"duckdb",
"pyiceberg",
"pyarrow",
"config_versioned",
"ngeohash",
"requests",
"scipy",
"matplotlib",
"sklearn",
"overturemaps",
"plotnine",
"mizani",
]
# Napoleon settings
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = False
# Autodoc settings
autodoc_default_options = {
"members": True,
"undoc-members": True,
"show-inheritance": True,
}
# Wrap function signatures so each argument appears on its own line
python_maximum_signature_line_length = 1
# -- Options for HTML output ---------------------------------------------------
html_theme = "furo"
html_theme_options = {
# Show only our custom view-this-page override (no edit button)
"top_of_page_buttons": ["view"],
}
html_static_path = ["_static"]
html_css_files = ["custom.css"]