mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2025-08-06 05:34:27 -04:00
Add basic instructions to build the docs
This commit is contained in:
parent
ba609d123e
commit
40a1698269
1 changed files with 15 additions and 0 deletions
15
README.md
15
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
|
To contribute, please see [how to edit the
|
||||||
documentation](https://www.qubes-os.org/doc/how-to-edit-the-documentation/).
|
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`
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue