Incus の日本語ドキュメントは、https://incus-ja.readthedocs.io/ja/latest/(原文のドキュメントはhttps://linuxcontainers.org/incus/docs/latest/)で閲覧できます。
GitHub でもドキュメントの基本的なレンダリングを提供していますが、include やクリッカブルリンクなどの重要な機能が欠落しています。そのため、公開ドキュメントを読むことをお勧めします。
Incus のドキュメントはSphinxでビルドされます。
ドキュメントはMarkdownとMySTの拡張で書かれています。 構文のヘルプやガイドラインについては、ドキュメントチートシート (ソース)を参照してください。
構成に関しては、このドキュメントではDiátaxisアプローチを採用しています。
ドキュメントをビルドするには、リポジトリのルートディレクトリーからmake doc
を実行します。このコマンドは必要なツールをインストールして、出力をdoc/html/
ディレクトリーにレンダリングします。
変更されたファイルのみを対象に(ツールを再インストールすることなく)ドキュメントを更新するには、make doc-incremental
を実行します。
Pull Request をオープンする前に、ドキュメントが警告なしでビルドできることを確認してください(警告はエラーとして扱われます)。
ドキュメントをローカルでプレビューするには、make doc-serve
を実行しhttp:https://localhost:8001
をブラウザで開いてください。