Commit 9da1369
committed
[Docs] Fill in stub pages, fix drift, and add a real Chinese translation
Four English pages were `[TBD]` placeholders and `examples/simulation.md`
carried 19 more `[TBD]` sections. Fill them in, verified against the
wrapper source rather than assumed:
- `getting_started/installation.md`: requirements, PyPI install, the three
optional ML-backed algorithms and their CMake flags, source builds.
- `examples/analysis.md`: all 11 `AnalysisOption` fields and 5
`AnalysisParam` fields with real defaults, output files, and the
C-reader-only restriction.
- `api.md`: hand-written reference for the full exported surface,
including the actual enum members (`ReqOp` is `OP_*`, not `READ`/`WRITE`).
- `developer.md`: layout, build system, testing, adding an algorithm, docs
workflow, CI, releasing.
- `examples/simulation.md`: real parameters and defaults for every
algorithm, plus the missing `Size` section, the `cache_size`-as-ratio
behaviour, and a `CacheBase` method table.
Corrections to existing content: Python floor is 3.10 (not 3.9) per
`requires-python`; `int_freq` -> `init_freq`; a quickstart snippet used an
undefined `lcs`; the FAQ used an absolute URL that broke under locale
fallback. Two lists rendered as literal `*` characters because they lacked
a preceding blank line.
The Chinese tree was three orphaned files at non-mirroring paths, so they
never rendered, and they documented an API that does not exist
(`cache.get_hit_ratio()`, `PythonHookCache`, `SyntheticReader(dist=...)`).
Delete them and translate all ten pages at paths mirroring `en/`.
Link-target headings carry explicit `attr_list` anchor IDs so cross-page
anchors resolve identically in both languages. `nav_translations` gains the
three labels that were still English, and `Getting Started` becomes
"入门指南" so it no longer collides with the Quickstart page's own title.
`mkdocs build --strict` passes and all 11 anchors are present in the built
HTML. Also ignore `docs/site/`, since the existing rule only covered
`/site` at the repo root.1 parent 7079d27 commit 9da1369
22 files changed
Lines changed: 2442 additions & 1102 deletions
File tree
- docs
- src
- en
- examples
- getting_started
- zh
- examples
- getting_started
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
153 | 153 | | |
154 | 154 | | |
155 | 155 | | |
| 156 | + | |
156 | 157 | | |
157 | 158 | | |
158 | 159 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
13 | | - | |
| 12 | + | |
14 | 13 | | |
| 14 | + | |
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| |||
85 | 85 | | |
86 | 86 | | |
87 | 87 | | |
88 | | - | |
| 88 | + | |
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
92 | 92 | | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
93 | 96 | | |
94 | 97 | | |
95 | 98 | | |
| |||
0 commit comments