Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
149 lines (144 loc) · 6.63 KB
/
Copy pathmkdocs.yml
File metadata and controls
149 lines (144 loc) · 6.63 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
site_name: pyvoro2
site_description: Scientific Python tools for forward and inverse 2D/3D Voronoi and power/Laguerre tessellations, periodic topology, and separator fitting.
site_url: https://delonecommons.github.io/pyvoro2/
repo_url: https://github.com/DeloneCommons/pyvoro2
repo_name: DeloneCommons/pyvoro2
edit_uri: edit/main/docs/
theme:
name: material
features:
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.top
- toc.integrate
- search.suggest
- search.highlight
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
docstring_style: google
show_source: false
show_root_heading: true
show_root_toc_entry: false
heading_level: 2
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path: .
check_paths: true
- pymdownx.arithmatex:
generic: true
- footnotes
extra_javascript:
- javascripts/mathjax.js
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra_css:
- stylesheets/extra.css
nav:
- Home: index.md
- User guide:
- Choosing an API: guide/choosing-api.md
- Capabilities and limitations: guide/capabilities.md
- Concepts: guide/concepts.md
- Glossary: guide/glossary.md
- Domains (3D): guide/domains.md
- Planar (2D): guide/planar.md
- Operations: guide/operations.md
- Topology and graphs: guide/topology.md
- Separator fitting: guide/powerfit.md
- v0.6.3–v0.8 migration: guide/migration-v0.7.md
- Visualization: guide/visualization.md
- Notebooks: guide/notebooks.md
- Theory:
- Overview: theory/index.md
- Power diagrams: theory/power-diagrams.md
- Inverse fitting from separator observations: theory/separator-inverse.md
- Development:
- Overview: development/index.md
- Development workflow: development/development-workflow.md
- v0.7 release checklist: development/release-checklist-v0.7.md
- Development plans:
- Overview: development/plans/index.md
- v0.7 archived plan: development/plans/archive/v0.7.md
- v0.8 completed cleanup plan: development/plans/archive/v0.8.md
- v0.8 completed audit remediation: development/plans/archive/v0.8-remediation.md
- Plan template: development/plans/template.md
- Archive: development/plans/archive/index.md
- Documentation conventions: development/documentation-conventions.md
- Architecture: development/architecture.md
- API lifecycle: development/api-lifecycle.md
- v0.8 API inventory: development/api-inventory.md
- Development audits:
- Overview: development/audits/index.md
- v0.8 historical audit/remediation record: development/audits/v0.8-pre-release.md
- Decision records:
- Overview: development/decisions/index.md
- Project scope and layering: development/decisions/0001-project-scope-and-layering.md
- Weights, radii, gauge, and component offsets: development/decisions/0002-weights-radii-and-gauge.md
- Compatibility-first evolution: development/decisions/0003-compatibility-first-evolution.md
- Canonical inverse namespace: development/decisions/0004-canonical-inverse-namespace.md
- Common tessellation result: development/decisions/0005-tessellation-result-contract.md
- v0.8 cleanup release: development/decisions/0006-v0.8-cleanup-release.md
- Separator inverse objective contract: development/decisions/0007-separator-objective-contract.md
- Separator solver and linear-backend selection: development/decisions/0008-separator-solver-and-linear-backend.md
- Certified scalar proximal solver: development/decisions/0009-certified-scalar-proximal-solver.md
- Strict native construction preconditions: development/decisions/0010-native-construction-preconditions.md
- Strict public input and ownership contract: development/decisions/0011-strict-input-and-ownership-contract.md
- Certified periodic nearest-image geometry: development/decisions/0012-certified-periodic-image-geometry.md
- Central generator preparation and backend safety: development/decisions/0013-central-generator-preparation-and-backend-safety.md
- Two-layer separator observation and source identity: development/decisions/0014-separator-observation-and-source-identity.md
- Atomic separator active-set final state: development/decisions/0015-atomic-separator-active-state.md
- Severity-complete tessellation diagnostics: development/decisions/0016-severity-complete-tessellation-diagnostics.md
- Post-v0.8 stabilization before 1.0: development/decisions/0017-v0.9-functional-stabilization-before-1.0.md
- Examples:
- notebooks/01_basic_compute.md
- notebooks/02_periodic_graph.md
- notebooks/03_locate_and_ghost.md
- notebooks/04_powerfit.md
- notebooks/05_visualization.md
- notebooks/06_powerfit_reports.md
- notebooks/07_powerfit_infeasibility.md
- notebooks/08_powerfit_active_path.md
- API reference:
- Overview: reference/index.md
- Spatial (3D):
- Domains: reference/domains.md
- API: reference/api.md
- Common result: reference/result.md
- Diagnostics: reference/diagnostics.md
- Validation: reference/validation.md
- Duplicate check: reference/duplicates.md
- Normalization: reference/normalize.md
- Face properties: reference/face_properties.md
- Visualization (3D): reference/viz3d.md
- Planar (2D):
- Overview: reference/planar/index.md
- Domains: reference/planar/domains.md
- API: reference/planar/api.md
- Common result: reference/result.md
- Diagnostics: reference/planar/diagnostics.md
- Normalization: reference/planar/normalize.md
- Validation: reference/planar/validation.md
- Edge properties: reference/edge_properties.md
- Visualization (2D): reference/viz2d.md
- Inverse fitting:
- High-level API: reference/inverse/index.md
- Advanced separator API: reference/inverse/separator.md
- Project:
- About: project/about.md
- Roadmap: project/roadmap.md
- v0.8.0 release notes: project/release-notes-v0.8.md
- Changelog: about/changelog.md
- License: project/license.md
- AI-assisted development: project/ai.md