Files
obikmer/mkdocs.yml
T
Eric Coissac 5c1584967f feat: enable index resumption and enforce directory creation
The command now supports reopening existing indexes instead of failing when the output file exists. Control flow branches between opening an existing index and constructing a new one, moving configuration setup exclusively to the creation path. Directory existence is enforced upfront with proper I/O error propagation. The --force flag retains its original semantics by removing the target directory before proceeding with a fresh build.
2026-08-21 05:06:38 +02:00

70 lines
2.4 KiB
YAML

site_name: obikmer
docs_dir: DevDocMD
site_dir: DevDoc
theme:
name: material
plugins:
- mermaid2:
- bibtex:
bib_file: DevDocMD/references.bib
csl_file: DevDocMD/ecology-letters.csl
enable_inline_citations: false
markdown_extensions:
- admonition
- footnotes
- tables
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.arithmatex:
generic: true
extra_javascript:
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
nav:
- Home: index.md
- Installation: installation.md
- Theory:
- Kmers and super-kmers: kmers.md
- DNA encoding: theory/encoding.md
- Entropy filter: theory/entropy.md
- Minimizer selection: theory/minimizer.md
- Partitioning architecture: theory/indexing.md
- Central-position SNP distance (discussion): theory/evolutionary_distances.md
- Implementation:
- SuperKmer: implementation/superkmer.md
- Kmer: implementation/kmer.md
- Chunk reader: implementation/chunkreader.md
- Construction pipeline: implementation/pipeline.md
- obipipeline library: implementation/obipipeline.md
- On-disk storage: implementation/storage.md
- MPHF selection: implementation/mphf.md
- Unitig evidence encoding: implementation/unitig_evidence.md
- Evidence elimination (discussion): implementation/evidence_elimination.md
- obikindex layer tier: implementation/layer_tier.md
- PersistentCompactIntVec: implementation/persistent_compact_int_vec.md
- PersistentBitVec: implementation/persistent_bit_vec.md
- Merge command: implementation/merge.md
- Merge parallelism & memory: implementation/merge_parallelism.md
- Kmer filtering: implementation/filtering.md
- Select command: implementation/select.md
- obitaxonomy crate: implementation/obitaxonomy.md
- "Benchmark: query-path testing": implementation/benchmark_query_testing.md
- "Partition and layer caching (discussion)": implementation/partition_layer_cache.md
- Architecture:
- Sequences: architecture/sequences/invariant.md
- Kmer index: architecture/index_architecture.md
- Sibling annex (discussion): architecture/siblings.md
- NUMA-aware worker pools: architecture/numa_worker_pools.md
- NUMA-aware partition runner: architecture/numa_partition_runner.md
watch:
- DevDocMD
- mkdocs.yml