Rust API#

The canonic library crate is documented inside this Shibuya site via sphinxcontrib-rust (same pattern as rgpot): module pages are generated from the Rust sources during ./docs/build.sh and appear under the toctree below.

Module map#

  • config

    canonic.toml / CLI prefix and optional [jira] settings.

  • corpus

    Walk and load {prefix}-*.md responses with front matter.

  • check

    Quality check: prefix, sop, ids, team-generic closings.

  • convert

    Pandoc markdown ↔ Jira wiki markup.

  • index

    Tantivy reindex, BM25 search, near-duplicate pairs.

  • lint

    Vale CLI and in-process Harper grammar checks.

  • doctor

    Tooling presence (pandoc, Vale, Harper).

  • jira_import

    Free REST probe, import drafts, explicit comment POST.

  • scaffold

    New templates and promote import → responses.

  • tui

    Interactive ratatui corpus browser.

crate canonic module map

Public modules re-exported from canonic:: - full signatures in the generated reference below.

Building the site#

# needs emacs (org export), Python venv deps, and sphinx-rustdocgen (cargo install)
./docs/build.sh
# open docs/build/index.html - Rust API is under docs/build/api.html and crates/

# sphinx-rustdoc-postprocess injects the crate toctree here at build time.

Rust crate reference#