1.4 KiB
1.4 KiB
ss-tools
Development Environment
- Рабочий виртуальный окружение (
.venv) находится внутриbackend/:backend/.venv.
AXIOM doc-gen
Генерация документации (Doxygen/JSDoc) из семантических контрактов выполняется
CLI-бинарём doc-gen из Rust-проекта axiom-mcp (соседняя директория ../axiom-mcp).
# 1. Собрать бинарник (один раз)
cargo build --release --bin doc-gen --manifest-path ../axiom-mcp/Cargo.toml
# 2. Переиндексировать workspace и собрать Doxygen HTML
../axiom-mcp/target/release/doc-gen \
--workspace-root /home/busya/dev/ss-tools \
--html /tmp/ss-tools-doxygen
# 3. Только навигационный граф (без doxygen)
../axiom-mcp/target/release/doc-gen \
--workspace-root /home/busya/dev/ss-tools \
--nav /tmp/ss-tools-nav
Примечания:
--workspace-rootпередавать абсолютным путём (относительный путь ломает проверкуsafe_joinпри записи в DuckDB).- Результат doxygen:
.dox-страницы,Doxyfileи каталогhtml/внутри--html-директории. - Остальные опции:
doc-gen --help(формат, per-file вывод,--filter,--group-cap,--body-lines).