ddb0810af0
* Updated documentation Mostly I've moved things around, cleaned up some dead paths and added more clarity. * Cleaned up !superusers section * Mentioning of accessibility |
||
---|---|---|
.. | ||
_static | ||
archinstall | ||
examples | ||
flowcharts | ||
help | ||
installing | ||
Makefile | ||
README.md | ||
conf.py | ||
index.rst | ||
logo.png | ||
pull_request_template.md |
README.md
Dependencies
In order to build the docs locally, you need to have the following installed:
For example, you may install these dependencies using pip:
pip install -U sphinx sphinx-rtd-theme
For other installation methods refer to the docs of the dependencies.
Build
In archinstall/docs
, run make html
(or specify another target) to build locally. The build files will be in archinstall/docs/_build
. Open _build/html/index.html
with your browser to see your changes in action.