You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: streamline Python docs with unified guides and clearer examples
- Refresh overview with the core “fast, correct, safe, simple” example plus clearer file/tag/roundtrip sections.
- Replace Usage with a “YAML in 2 Minutes” guide covering a full first example, collections, scalars, and an end-to-end sample.
- Expand Tags into an advanced guide on handlers, mapping keys, streams, anchors, tag directives, and core tags, using concise assertions and named args.
- Tidy API examples to assert full round-trips.
- Update MkDocs nav to group the two guides under Guides.
Copy file name to clipboardExpand all lines: docs/index.md
+93-11Lines changed: 93 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# yaml12
2
2
3
-
`yaml12` exposes the Rust-based `saphyr` YAML 1.2 parser and emitter to Python through a small, function-first API. The bindings keep conversions lean, support multi-document streams, and materialize tagged nodes or unhashable mapping keys as a single lightweight `Yaml` dataclass (also exported as `Tagged` and `MappingKey`); otherwise you just use plain Python types.
3
+
`yaml12` exposes the Rust-based `saphyr` YAML 1.2 parser and emitter to Python through a small, function-first API. The bindings keep conversions lean, support multi-document streams, and materialize tagged nodes or unhashable mapping keys as a single lightweight `Yaml` dataclass; otherwise you just use plain Python types.
4
4
5
5
- Parse YAML text or files into familiar Python types with `parse_yaml` and `read_yaml`; handlers apply to both values and keys.
6
6
- Serialize Python values back to YAML with `format_yaml` or write directly to disk/stdout with `write_yaml`, including non-core tags.
0 commit comments