Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
274 lines (264 loc) · 11.2 KB
/
Copy pathmkdocs.yml
File metadata and controls
274 lines (264 loc) · 11.2 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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
site_name: Tack
site_description: Scientific data analysis, visualization and portable GPU compute in Python.
# Published to GitHub Pages (versioned by mike: /latest/, /dev/, /0.4/, ...),
# so this is the project-page URL rather than a Read the Docs one. It matters beyond cosmetics: canonical tags and the
# generated sitemap are built from it. `.readthedocs.yaml` is still in the
# repo and still correct -- if that is ever connected too, RTD sets its own
# canonical and this stays pointing at the Pages site.
site_url: https://kitware.github.io/tack/
repo_url: https://github.com/Kitware/tack
repo_name: Kitware/tack
edit_uri: edit/main/docs/
# The guides were written as plain markdown long before this file existed and
# are used as-is. That is why Material is here rather than Sphinx: the 2,800
# lines under docs/ needed no conversion, and tack's docstrings are prose
# rather than Args:/Returns: blocks, so autodoc's structured-parameter
# handling -- the main thing Sphinx would buy -- has almost nothing to act on.
docs_dir: docs
# The Griffe extension the API pages load (mkdocstrings, below), not a page.
exclude_docs: |
_ext/
_writing/
theme:
name: material
# The banner on every version but the latest release (overrides/main.html).
custom_dir: overrides
# The system's fonts, as NumPy's documentation (the PyData theme) uses.
font: false
features:
- navigation.tabs
- navigation.sections
# A section's index.md opens from its heading in the sidebar; breadcrumbs above
# each page and previous/next links below it, as NumPy's documentation has.
- navigation.indexes
- navigation.path
- navigation.footer
- navigation.top
- navigation.tracking
- content.action.edit
- content.code.copy
- content.code.annotate
# Ties every backend tab on the page together: pick CUDA once and every
# other example on the page follows. Five backends is exactly the case
# this exists for.
- content.tabs.link
- search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: indigo
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/weather-sunny
name: Switch to light mode
# Writes the deprecations page's table from Tack's registry.
hooks:
- docs/_ext/deprecations.py
markdown_extensions:
- admonition
- attr_list
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.inlinehilite
- pymdownx.snippets:
check_paths: true
dedent_subsections: true
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
plugins:
- search
- mkdocstrings:
handlers:
python:
paths:
- packages/tack-core/src
- packages/tack-vis/src
options:
# tack-vis's tack.dataset and tack.interop, under tack-core's tack.
extensions:
- docs/_ext/tack_namespace.py:TackNamespace
docstring_style: google
docstring_options:
# Args sections without types (Tack has no annotations), and a
# Returns paragraph is one value, not one per line.
warn_missing_types: false
returns_multiple_items: false
show_source: true
show_root_heading: true
heading_level: 3
members_order: source
separate_signature: true
show_signature_annotations: true
merge_init_into_class: true
# A page left out of the nav is a warning, which --strict makes an error:
# otherwise it builds, unreachable, and nothing says so.
validation:
nav:
omitted_files: warn
not_found: warn
nav:
# Five tabs, as NumPy's documentation has a few: what comes before the layers
# (NumPy's "Getting started"), the guide (the four layers, each a group of the
# sidebar), the reference, the developers' guide and the design notes.
- Get started:
- index.md
- Use cases: use-cases.md
- Install: install.md
- Guide:
- Core:
- core/index.md
- How a Tack program runs: core/how-programs-run.md
- Learn:
- Arrays and types: core/arrays-and-types.md
- Kernels: core/kernels.md
- Control flow and math: core/control-flow-and-math.md
- Device functions: core/device-functions.md
- Vectors and matrices: core/vectors-and-matrices.md
- Device classes: core/device-classes.md
- Reductions, scans and sorts: core/reductions-scans-sorts.md
- Memory and parallel correctness: core/memory-and-correctness.md
- Do:
- Choose a device: core/choose-a-device.md
- Share arrays: core/share-arrays.md
- Workgroups, atomics, textures, random numbers: core/workgroups-atomics-textures.md
- Wait without blocking (asyncio): core/asyncio.md
- Debug and time a kernel: core/debug-and-time.md
- Keep compiled kernels: core/kernel-cache.md
- Examples:
- core/examples.md
- Heat diffusion: users-guide/tutorials/heat.md
- Advecting dye: users-guide/tutorials/dye.md
- Trail-following agents: users-guide/tutorials/physarum.md
- Marching squares: users-guide/tutorials/contours.md
- Particle-to-grid simulation: users-guide/tutorials/mpm.md
- Tiled n-body forces: users-guide/tutorials/nbody.md
- Communication:
- communication/index.md
- Blocks and worlds: communication/blocks-and-worlds.md
- Exchange and plans: communication/exchange-and-plans.md
- Route points to blocks: communication/routing.md
- Sort and reduce over blocks: communication/sort-and-reduce.md
- Run under MPI: communication/mpi.md
- Data:
- data/index.md
- Understand:
- Topology and geometry: data/topology-and-geometry.md
- Fields and where values live: data/fields.md
- Coordinates, units and time: data/units-coordinates-time.md
- Cells and meshes: data/cells-and-meshes.md
- Polyhedra, polygons and polylines: data/polyhedra.md
- Higher-order and finite-element data: data/higher-order.md
- Particles and point clouds: data/particles.md
- AMR hierarchies and octrees: data/amr-and-octrees.md
- Data in pieces: data/pieces.md
- Storage and layouts: data/storage-and-layouts.md
- Do:
- Build meshes and fields: data/build-meshes-and-fields.md
- Connect a simulation's data: data/connect-simulation-data.md
- Data on devices: data/devices.md
- Visualization:
- visualization/index.md
- Filters by task:
- Extract: visualization/extract.md
- Derive: visualization/derive.md
- Compute with expressions: visualization/expressions.md
- Sample and trace: visualization/sample-and-trace.md
- Reduce: visualization/reduce.md
- Points and particles: visualization/points-and-particles.md
- Adaptive data: visualization/adaptive-data.md
- Finite-volume data and fluxes: visualization/finite-volume.md
- At scale and over time:
- Filters over pieces: visualization/over-pieces.md
- Steps over time: visualization/over-time.md
- Extend:
- Views: visualization/views.md
- Write a mesh algorithm: visualization/write-a-mesh-algorithm.md
- Write a filter: visualization/write-a-filter.md
- Connect:
- VTK: visualization/vtk.md
- MFEM, Warp and others: visualization/mfem-warp-and-others.md
- Examples:
- visualization/examples.md
- Gallery: vis-guide/gallery.md
- MFEM gallery: vis-guide/mfem-gallery.md
- Reference:
- Core:
- Runtime API: contracts/runtime-api.md
- API summary: reference/api.md
- Array API: design/array-api.md
- Kernel language: reference/language-contract.md
- Backends: reference/backends.md
- Backend capabilities: contracts/backend-capabilities.md
- Data:
- Dataset API: vis-guide/reference/dataset-api.md
- Data model: vis-guide/reference/data-model.md
- Cell types and bases: vis-guide/16-cells-and-bases.md
- Units and quantities: vis-guide/reference/units.md
- Visualization:
- Algorithms: vis-guide/reference/algorithms.md
- Interoperability: vis-guide/reference/interop.md
- Glossary: reference/glossary.md
- Deprecations: reference/deprecations.md
- Performance: performance.md
- Developer's guide:
- developers-guide/index.md
- Architecture: developers-guide/01-architecture.md
- AST transform: developers-guide/02-ast-transform.md
- IR: developers-guide/03-ir.md
- IR passes: developers-guide/04-ir-passes.md
- Code generation: developers-guide/05-codegen.md
- Runtime: developers-guide/06-runtime.md
- Templates: developers-guide/07-templates.md
- Adding features: developers-guide/08-adding-features.md
- Conformance and validation: contracts/conformance.md
- Design notes:
- design/index.md
- Principles: design/principles.md
- Compilation pipeline: design/compilation-pipeline.md
- Specialization and caching: design/specialization-and-caching.md
- Numerical semantics: design/numerical-semantics.md
- Parallel execution: design/parallel-execution.md
- Memory and aliasing: design/memory-and-aliasing.md
- CPU threading policy: design/cpu-threading.md
- Backend implementations: design/backend-implementations.md
- Vendor workarounds: design/vendor-workarounds.md
- Interoperability: design/interoperability.md
- Plans:
- design/plans/index.md
- Cut filters' memory: design/plans/cut-filters-memory.md
- Inspecting device-class objects: design/plans/inspect-template.md
- Field quantities: design/plans/field-quantities.md
- Contracts: contracts/index.md
- Dataset API design: vis-guide/design/dataset-api.md
- Polyhedra: vis-guide/design/polyhedra.md
- View storage and composition: vis-guide/design/view-composition.md
extra:
# A version selector over the folders mike publishes: `0.4`, `0.5`, ...,
# `dev` (main), with `latest` the newest release and the site's default.
version:
provider: mike
default: latest
social:
- icon: fontawesome/brands/github
link: https://github.com/Kitware/tack
extra_css:
- stylesheets/tack.css
extra_javascript:
- assets/guide-section-links.js