2023-06-07 09:14:31 +00:00
|
|
|
# Documentation
|
|
|
|
|
2023-11-02 16:31:47 +00:00
|
|
|
This `doc` folder is the location of documentation for Subiquity.
|
2023-06-07 09:14:31 +00:00
|
|
|
|
2023-11-02 16:31:47 +00:00
|
|
|
In the not distant past, there was also a `../documentation` folder, but that
|
|
|
|
is now an obsolete copy of what was on Discourse.
|
2023-08-14 10:36:26 +00:00
|
|
|
|
|
|
|
# Local preview
|
|
|
|
|
|
|
|
To build this documentation, you can run `make install` from this folder to
|
2023-11-02 16:31:47 +00:00
|
|
|
create the virtual environment.
|
2023-08-14 10:36:26 +00:00
|
|
|
|
|
|
|
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.
|