archinstall/docs
Anton Hvornum ddb0810af0
Improve documentation v2.3.1 (#843)
* Updated documentation

Mostly I've moved things around, cleaned up some dead paths and added more clarity.

* Cleaned up !superusers section

* Mentioning of accessibility
2022-01-05 23:42:06 +01:00
..
_static Added a tribute logo 2021-06-01 22:24:26 +02:00
archinstall Improve documentation v2.3.1 (#843) 2022-01-05 23:42:06 +01:00
examples Update documentation (#803) 2021-12-18 19:01:40 +01:00
flowcharts Moved around some blocks 2021-05-02 21:58:43 +02:00
help Improve documentation v2.3.1 (#843) 2022-01-05 23:42:06 +01:00
installing Improve documentation v2.3.1 (#843) 2022-01-05 23:42:06 +01:00
Makefile Added documentation for: https://python-archinstall.readthedocs.io/en/latest/ 2020-09-28 16:38:10 +02:00
README.md Update documentation (#803) 2021-12-18 19:01:40 +01:00
conf.py Replace for loops with comprehensions 2021-07-16 10:42:29 +03:00
index.rst Improve documentation v2.3.1 (#843) 2022-01-05 23:42:06 +01:00
logo.png Converted the lib to a pip supported structure to make packaging easier. Also tweaked some minor issues and added the AUR function 2020-07-06 18:44:42 +02:00
pull_request_template.md Proofreading: Fix misc. spelling and grammar issues 2021-05-18 09:36:22 -04:00

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.