API reference
python:doukimd
module doukimd
doukimd
Source: src/doukimd/__init__.py:1
DoukiMD, Markdown documentation powered by Douki.
Modules
-
__main__ — Invoke the DoukiMD command line interface.
-
api — Collect Python declarations without importing project code.
-
assets — Copy explicitly selected documentation assets without source escapes.
-
build — Compile, validate, and safely publish a static documentation site.
-
cli — Build and validate DoukiMD projects from the command line.
-
collection — Collect public Python APIs with declaration provenance and variants.
-
config — Load configuration and confine all project paths.
-
content — Discover authored pages and expand their Markdown templates.
-
errors — Structured build errors.
-
html — Validate links and anchors in explicitly enabled authored HTML.
-
indexes — Validated immutable snapshots for one compilation.
-
markdown — Native API blocks and references in a CommonMark document.
-
models — Validated configuration and build models.
-
navigation — Build theme-independent navigation from planned pages and symbols.
-
navigation_plan — Prepare immutable menu structure once and select page-local states.
-
notebook_models — Typed projections of validated notebook cells and saved outputs.
-
notebook_rendering — Expand notebook cells and saved MIME outputs into document tokens.
-
notebooks — Read version four notebooks without importing kernels or running code.
-
plugins — Explicitly enabled plugin context providers.
-
references — Resolve API references within explicitly selected source folders.
-
runtime — Runtime type checking for all arguments and collection items.
-
search — Build deterministic search records from expanded document content.
-
theme — Bundle frontend assets and syntax colors without network requests.
Functions
- get_version — Return the installed version or the source-tree fallback.