Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
137 lines (131 loc) · 4.9 KB
/
Copy pathmkdocs.yml
File metadata and controls
137 lines (131 loc) · 4.9 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
site_name: JAXTPC
site_description: GPU-accelerated, differentiable liquid-argon TPC detector simulation in JAX
site_url: https://deeplearnphysics.github.io/JAXTPC/
repo_url: https://github.com/DeepLearnPhysics/JAXTPC
repo_name: DeepLearnPhysics/JAXTPC
edit_uri: edit/main/docs/
docs_dir: docs
# Match CI (`mkdocs build --strict`) locally too, so `mkdocs serve`/`build`
# surface broken links + mkdocstrings warnings before they fail CI.
strict: true
# PLAN.md is the internal docs build spec — kept in-repo for maintainers but
# not published on the public site (and not linked as an internal page).
exclude_docs: |
PLAN.md
theme:
name: material
features:
- navigation.tabs # top-level sections become tabs
- navigation.sections # second-level groups shown in the sidebar
- navigation.indexes # sections can have a landing page
- navigation.top
- navigation.instant
- toc.follow
- content.code.copy
- content.code.annotate
- search.suggest
palette:
- scheme: default
primary: indigo
toggle: { icon: material/weather-night, name: Dark mode }
- scheme: slate
primary: indigo
toggle: { icon: material/weather-sunny, name: Light mode }
# Build with the docs extra: pip install -e ".[docs]" && mkdocs serve
plugins:
- search
- mkdocstrings: # auto API reference from docstrings (reference/api/*)
handlers:
python:
paths: ["."]
options:
docstring_style: numpy
show_source: true
show_root_heading: true
members_order: source
- mkdocs-jupyter: # render the synthetic tutorial notebooks (docs/tutorials/)
include_source: true
execute: true # execute-at-build: plots live only in the built site,
# never committed (source notebooks stay stripped)
allow_errors: false
theme: light
markdown_extensions:
- admonition
- tables
- toc: { permalink: true }
- pymdownx.highlight
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
nav:
- Get started:
- Home: index.md
- Install: install.md
- Quickstart: quickstart.md
- Examples:
- Overview: examples.md
- Quickstart: tutorials/00_quickstart.ipynb
- Physics walkthrough: tutorials/physics_walkthrough.ipynb
- Custom detector: tutorials/custom_detector.ipynb
- Understand:
- Architecture:
- Reading guide: architecture/reading-guide.md
- Pipeline overview: architecture/pipeline-overview.md
- Data model: architecture/data-model.md
- Config vs params: architecture/config-vs-params.md
- Execution paths: architecture/execution-paths.md
- The simulator: architecture/simulator.md
- Concepts:
- Coordinates & frames: concepts/coordinates.md
- Padding & masking: concepts/padding-masking.md
- Capacities & overflow: concepts/capacities.md
- Physics & detector:
- Physics:
- Overview: physics/overview.md
- Recombination: physics/recombination.md
- Drift & diffusion: physics/drift-diffusion.md
- Response kernels: physics/response-kernels.md
- Electronics & noise: physics/electronics-noise.md
- Space charge (SCE): physics/sce.md
- Units (ENC vs ADC): physics/units.md
- Detector:
- Config schema: detector/config-schema.md
- Presets: detector/presets.md
- Wire vs pixel: detector/wire-vs-pixel.md
- Visualization:
- Plotting: viz/plotting.md
- Viewer & GIF: viz/viewer.md
- Production:
- Batch pipeline: production/batch.md
- Data formats: production/data-formats.md
- Profiler: production/profiler.md
- Scaling: production/scaling.md
- Differentiable & reco:
- Differentiable:
- Overview: differentiable/overview.md
- Losses: differentiable/losses.md
- Particle generation: differentiable/particle-generation.md
- Optimization: differentiable/optimization.md
- Truth & track hits: truth/track-hits.md
- Reference:
- Glossary: reference/glossary.md
- FAQ: reference/faq.md
- Citation: reference/citation.md
- API:
- Overview: reference/api/index.md
- Core simulation: reference/api/core.md
- Data types: reference/api/data-types.md
- Loading & config: reference/api/loading.md
- Physics: reference/api/physics.md
- Response & readout: reference/api/response.md
- Post-processing: reference/api/post-processing.md
- Truth: reference/api/truth.md
- Differentiable: reference/api/differentiable.md
- Visualization: reference/api/visualization.md
- Production I/O: reference/api/production.md
- Contributing:
- Development: contributing/development.md
- Adding a detector: contributing/adding-a-detector.md
- Internal I/O formats: contributing/io-formats-internal.md