Source: factory.deploy/ObjWiki.py
Compiles Axion codebase into a Wiki.js-ready
documentation site with full-text search index.
| Method | Signature | Description |
|---|---|---|
| scan_docs | scan_docs() -> list |
|
| scan_yaml_docs | scan_yaml_docs() -> list |
|
| scan_python_docs | scan_python_docs() -> list |
|
| build_search_index | build_search_index(all_docs: list) -> list |
|
| generate_home | generate_home(docs: list) -> str |
|
| generate_factory_index | generate_factory_index(factory: str, docs: list) -> str |
|
| build | build(output_dir: str = '') -> int |
|
| clean | clean(output_dir: str = '') -> None |
|
| status | status() -> dict |
|
| sync_wikijs | sync_wikijs(port: int = 3000, api_token: str = '') -> bool |
|
| update | update(output_dir: str = '') -> int |
|
| install_hook | install_hook() -> bool |
|
| uninstall_hook | uninstall_hook() -> bool |
Compile all documentation into the wiki.
Remove all compiled wiki content.
Show documentation source statistics.
Rebuild wiki and trigger Wiki.js sync.
Install git post-commit hook.
Remove git post-commit hook.