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
# MRRC Documentation Configuration
# See docs/design/DOCS-REORG.md for the full reorganization plan
site_name: MRRC Documentation
site_url: https://dchud.github.io/mrrc/
site_description: MARC library for Rust and Python
repo_url: https://github.com/dchud/mrrc
repo_name: dchud/mrrc
theme:
name: material
palette:
# Light mode (default) - listed first so it's the default
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode - auto-activates if user's system prefers dark
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- search.highlight
- search.share
- content.code.copy
- content.tabs.link
plugins:
- search
- mkdocstrings:
handlers:
python:
paths:
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- admonition
- tables
- toc:
permalink: true
nav:
- Home: index.md
- Getting Started:
- getting-started/index.md
- Installation: getting-started/installation.md
- Python Quickstart: getting-started/quickstart-python.md
- Rust Quickstart: getting-started/quickstart-rust.md
- Tutorials:
- tutorials/index.md
- Python:
- tutorials/python/reading-records.md
- tutorials/python/writing-records.md
- tutorials/python/format-conversion.md
- tutorials/python/querying-fields.md
- tutorials/python/concurrency.md
- Rust:
- tutorials/rust/reading-records.md
- tutorials/rust/writing-records.md
- tutorials/rust/format-conversion.md
- tutorials/rust/querying-fields.md
- tutorials/rust/concurrency.md
- Guides:
- guides/index.md
- Format Selection: guides/format-selection.md
- Migration from pymarc: guides/migration-from-pymarc.md
- Working with Large Files: guides/working-with-large-files.md
- Threading (Python): guides/threading-python.md
- Performance Tuning: guides/performance-tuning.md
- Query DSL: guides/query-dsl.md
- BIBFRAME Conversion: guides/bibframe-conversion.md
- Reference:
- reference/index.md
- Python API: reference/python-api.md
- Rust API: reference/rust-api.md
- Format Support: reference/formats.md
- MARC Primer: reference/marc-primer.md
- Character Encoding: reference/encoding.md
- Examples:
- examples/index.md
- Contributing:
- contributing/index.md
- Development Setup: contributing/development-setup.md
- Testing: contributing/testing.md
- Release Procedure: contributing/release-procedure.md
- Architecture: contributing/architecture.md
- Design: design/index.md
- History: history/index.md
- Benchmarks:
- benchmarks/index.md
- Results: benchmarks/results.md
- FAQ: benchmarks/faq.md