rustkmer 0.5.2

High-performance k-mer counting tool in Rust
Documentation 
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

site_name: RustKmer Python API Documentation
site_description: High-performance k-mer analysis library for Python
repo_name: rustkmer/rustkmer
repo_url: https://github.com/rustkmer/rustkmer
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright © 2025 RustKmer Team

# Configuration
theme:
  name: material
  language: en
  palette:
    # Light mode
    - scheme: default
      primary: blue
      accent: orange
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: blue
      accent: orange
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  logo: assets/logo.png
  favicon: assets/favicon.png
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - toc.follow

# Plugins
plugins:
  - search:
      lang: en

  - search:
      lang: en

# Markdown extensions
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

# Navigation
nav:
  - Home: index.md
  - Installation: installation.md
  - User Guide:
      - Quick Start: user-guide/quickstart.md
      - Concepts: user-guide/concepts.md
      - Examples: user-guide/examples.md
      - Tutorials:
          - Basic Workflow: user-guide/tutorials/basic-workflow.md
          - Large Datasets: user-guide/tutorials/large-datasets.md
          - Performance: user-guide/tutorials/performance.md
          - Integration: user-guide/tutorials/integration.md
  - API Reference:
      - Overview: api-reference/overview.md
      - KmerCounter: api-reference/kmercounter.md
      - Database: api-reference/database.md
      - FuzzyQuery: api-reference/fuzzyquery.md
      - Exceptions: api-reference/exceptions.md
  - Examples:
      - Basic Usage: examples/basic-usage.md
      - Database Operations: examples/database-ops.md
      - Fuzzy Search: examples/fuzzy-search.md
      - Batch Processing: examples/batch-processing.md
      - Merging Databases: examples/merging.md
      - Statistics: examples/statistics.md
      - Data Export: examples/data-export.md
      - Advanced Features: examples/advanced.md
  - Developer Guide:
      - Contributing: dev-guide/contributing.md
      - Architecture: dev-guide/architecture.md

# Customization
extra:
  # Social links
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rustkmer
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/rustkmer

  # Version selector
  version:
    provider: mike

  # Alternate languages
  alternate:
    - name: English
      link: /
      lang: en
    - name: 中文
      link: /zh/
      lang: zh

# Extra CSS/JS
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

# Development server (for local testing)
dev_addr: 0.0.0.0:8000

# Directory where documentation markdown files are located
docs_dir: .

# Directory where the output site will be built
site_dir: ../site

# Requirements for documentation
# Install with: pip install -r docs/requirements.txt