All Qubes OS Project documentation pages are stored as plain text files in this dedicated repository. By cloning and regularly pulling from this repo, users can maintain their own up-to-date offline copy of all Qubes documentation rather than relying solely on the Web.
Find a file
Ben Grande 04b669c163
Unify method to build the documentation
With duplication, inconsistencies appears, such as:

- Poetry did not have a version check of sphinx-build;
- Poetry did not discern between git clone and fetching other
  dependencies;
- Virtual environment and poetry documentation were different already;
- Build instructions sometimes used "qubes-doc" or "../qubes-doc".

New structure introduces sections to separate installation, lint and
build process.
2025-10-28 08:20:51 +01:00
_dev Adding missing link to qubes-core-qrexec 2025-09-06 12:26:34 +02:00
_ext Revert some configuration options 2025-08-12 09:25:54 -04:00
attachment Add a Howto on setting wallpapers 2025-10-13 12:22:55 +02:00
developer Unify method to build the documentation 2025-10-28 08:20:51 +01:00
introduction merge pr #1540, fixed merge conflicts 2025-10-19 19:14:07 -04:00
project-security Replace all anchors links by ref roles 2025-09-16 07:57:56 -04:00
user merge pr #1540, fixed merge conflicts 2025-10-19 19:14:07 -04:00
.gitignore add .venv to ignore 2025-09-12 09:26:38 +02:00
.readthedocs.yaml Revert some configuration options 2025-08-12 09:25:54 -04:00
.travis.yml Update travis to bionic 2020-09-29 15:12:04 +02:00
conf.py Merge branch 'pr/1543' 2025-09-27 10:31:20 +02:00
CONTRIBUTING.md merge upstream rst, add screenshots, rewrite how-to-edit-the-website, combine website and markdown-style-guide, enhance how-to-edit-the-rst-documentation and rst style guide, fix errors, added comments to conf.py, links to README & CONTRIBUTING 2025-09-09 05:29:19 -04:00
index.rst Add a Howto on setting wallpapers 2025-10-13 12:22:55 +02:00
pyproject.toml add esbonio preview configuration 2025-09-12 09:26:43 +02:00
README.md merge upstream rst, add screenshots, rewrite how-to-edit-the-website, combine website and markdown-style-guide, enhance how-to-edit-the-rst-documentation and rst style guide, fix errors, added comments to conf.py, links to README & CONTRIBUTING 2025-09-09 05:29:19 -04:00
requirements.txt Add sphinxext-opengraph extensions 2025-08-14 08:52:21 -04:00

Qubes OS Documentation

Canonical URL: https://doc.qubes-os.org

All Qubes OS Project documentation pages are stored as plain reStructuredText files in this dedicated repository. By cloning and regularly pulling from this repo, users can maintain their own up-to-date offline copy of all Qubes documentation rather than relying solely on the Web.

To contribute, please see how to edit the documentation.