Building Docs¶

The documentation source is Markdown so the same pages can be rendered as a web site with MkDocs or as a PDF with Pandoc.

Build the web site:

make -C docs html

The generated site is written to:

artifacts/docs/site/

Build the branded web site:

make -C docs html-brand

The branded site uses the MLTTDB brand assets and writes to:

artifacts/docs/site-brand/

Build both HTML variants:

make -C docs html-all

Build the PDF:

make -C docs pdf

The generated PDF is written to:

artifacts/docs/mlttdb-docs.pdf

The build tools are intentionally not vendored by this repository. Install mkdocs for HTML output and pandoc plus a supported PDF engine for PDF output.