From 40a16982691d5fe63b72ba1a38a2d469ac1937d4 Mon Sep 17 00:00:00 2001 From: parulin <161326115+parulin@users.noreply.github.com> Date: Sun, 27 Jul 2025 07:05:20 -0400 Subject: [PATCH] Add basic instructions to build the docs --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 0ab67025..5f203c10 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,18 @@ offline copy of all Qubes documentation rather than relying solely on the Web. To contribute, please see [how to edit the documentation](https://www.qubes-os.org/doc/how-to-edit-the-documentation/). + +## How to build the documentation + +In a qube, after cloning or downloading this repo, do: + + python3 -m venv .venv + source .venv/bin/activate + pip install -r requirements.txt + +Then, build the documentation using any sphinx builder, i.e. with HTML: + + sphinx-build -M html . build + +The HTML version of the documentation is now accessible in `build/html` +