CernVM-FS Documentation

This repository contains the canonical MkDocs sources and static assets for the CernVM-FS user documentation.

Building the documentation locally

This repository uses mike for published multi-version documentation and the version switcher. Use plain MkDocs targets for quick single-version sanity checks, and use mike when you want to preview or update the versioned docs tree.

Install the Python dependencies:

pip install -r requirements.txt

Build the site from the repository root:

mkdocs build

or:

make build

Serve the site locally for editing:

mkdocs serve

or:

make serve

Versioned documentation workflow

Preview the versioned documentation tree locally with mike:

mike serve

or:

make mike-serve

Update the published latest docs alias with mike:

mike deploy latest

or:

make mike-latest

The generated HTML output is written to site/.

PDF/EPUB automation is not currently provided by the root MkDocs setup. Read the Docs only offers built-in offline formats for Sphinx projects, and this repository does not yet define a separate MkDocs-compatible PDF/EPUB toolchain.