incus-mirror/doc

LXD documentation

The LXD documentation is available at: https://documentation.ubuntu.com/lxd/en/latest/

GitHub provides a basic rendering of the documentation as well, but important features like includes and clickable links are missing. Therefore, we recommend reading the published documentation.

Documentation format

The documentation is written in Markdown with MyST extensions.

For syntax help and guidelines, see the documentation cheat sheet (source).

Building the documentation

To build the documentation, run make doc from the root directory of the repository. This command installs the required tools and renders the output to the doc/html/ directory. To update the documentation for changed files only (without re-installing the tools), run make doc-incremental.

After building, run make doc-serve and go to http://localhost:8001 to view the rendered documentation.