subiquity/doc
Robert Krátký ce6dd33e80 Better introduction to autoinstall. 2024-04-09 12:58:51 +02:00
..
.sphinx Add search-bar Go button. 2024-01-10 16:17:57 +01:00
explanation Better introduction to autoinstall. 2024-04-09 12:58:51 +02:00
howto Better introduction to autoinstall. 2024-04-09 12:58:51 +02:00
reference doc: consistent top-level autoinstall keyword 2024-04-04 14:26:08 -07:00
reuse Language and formatting review of the Reference section. 2023-10-26 11:40:07 +02:00
tutorial Better introduction to autoinstall. 2024-04-09 12:58:51 +02:00
.custom_wordlist.txt doc: update wordlist 2024-04-04 14:26:12 -07:00
.gitignore Fix greedy .gitignore. 2023-10-18 14:37:11 +02:00
.wokeignore Adopt Docs Starter Pack config. 2023-10-06 14:50:56 +02:00
.wordlist.txt doc: update wordlist 2024-04-04 14:26:12 -07:00
Makefile Add docs checks to GH workflows: 2023-10-23 21:56:36 +02:00
README.md doc: update readme for removal of `documentation` 2023-11-02 18:32:56 +02:00
conf.py Update Sphinx extension names. 2024-01-10 16:17:50 +01:00
custom_conf.py Update and fix project navigation 2023-10-23 16:28:43 +02:00
google8dda472a993637b7.html Add Google Consople verif. file. 2023-10-18 15:48:15 +02:00
index.rst Review howto language and formatting. 2023-10-27 18:06:59 +02:00
intro-to-autoinstall.rst Better introduction to autoinstall. 2024-04-09 12:58:51 +02:00

README.md

Documentation

This doc folder is the location of documentation for Subiquity.

In the not distant past, there was also a ../documentation folder, but that is now an obsolete copy of what was on Discourse.

Local preview

To build this documentation, you can run make install from this folder to create the virtual environment.

Then run the make run command, which will build a html version of the docs, and serve the docs in the virtual environment. This is very convenient if you are working on them and want your saved changes to be reflected as a working preview.