Skip to content

Latest commit

 

History

History
 
 

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
.sphinx
.sphinx
 
 
explanation
explanation
 
 
howto
howto
 
 
images
images
 
 
reference
reference
 
 
tutorial
tutorial
 
 
.wordlist.txt
.wordlist.txt
 
 
README.md
README.md
 
 
api-extensions.md
api-extensions.md
 
 
api.md
api.md
 
 
architectures.md
architectures.md
 
 
authentication.md
authentication.md
 
 
authorization.md
authorization.md
 
 
backup.md
backup.md
 
 
client.md
client.md
 
 
cloud-init.md
cloud-init.md
 
 
clustering.md
clustering.md
 
 
conf.py
conf.py
 
 
config-options.md
config-options.md
 
 
config_options.txt
config_options.txt
 
 
config_options_cheat_sheet.md
config_options_cheat_sheet.md
 
 
container-environment.md
container-environment.md
 
 
contributing.md
contributing.md
 
 
daemon-behavior.md
daemon-behavior.md
 
 
database.md
database.md
 
 
debugging.md
debugging.md
 
 
dev-incus.md
dev-incus.md
 
 
doc-cheat-sheet.md
doc-cheat-sheet.md
 
 
environment.md
environment.md
 
 
events.md
events.md
 
 
external_resources.md
external_resources.md
 
 
faq.md
faq.md
 
 
general.md
general.md
 
 
image-handling.md
image-handling.md
 
 
images.md
images.md
 
 
index.md
index.md
 
 
installing.md
installing.md
 
 
instance-exec.md
instance-exec.md
 
 
instances.md
instances.md
 
 
internals.md
internals.md
 
 
metrics.md
metrics.md
 
 
migration.md
migration.md
 
 
networks.md
networks.md
 
 
packaging.md
packaging.md
 
 
profiles.md
profiles.md
 
 
projects.md
projects.md
 
 
remotes.md
remotes.md
 
 
requirements.md
requirements.md
 
 
rest-api-spec.md
rest-api-spec.md
 
 
rest-api.md
rest-api.md
 
 
rest-api.yaml
rest-api.yaml
 
 
security.md
security.md
 
 
server.md
server.md
 
 
server_config.md
server_config.md
 
 
storage.md
storage.md
 
 
substitutions.yaml
substitutions.yaml
 
 
support.md
support.md
 
 
syscall-interception.md
syscall-interception.md
 
 
third_party.md
third_party.md
 
 
userns-idmap.md
userns-idmap.md
 
 

README.md

Incus documentation

The Incus documentation is available at: https://linuxcontainers.org/incus/docs/main/

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.

How it works

Documentation framework

Incus' documentation is built with Sphinx.

It is written in Markdown with MyST extensions. For syntax help and guidelines, see the documentation cheat sheet (source).

For structuring, the documentation uses the Diátaxis approach.

Build 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.

Before opening a pull request, make sure that the documentation builds without any warnings (warnings are treated as errors). To preview the documentation locally, run make doc-serve and go to http://localhost:8001 to view the rendered documentation.