Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs/README.md
blob: 7ab47d2603622cc27dac612f7b355a75b98632c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
## Dependencies

In order to build the docs locally, you need to have the following installed:

- [sphinx-doc](https://www.sphinx-doc.org/en/master/usage/installation.html)
- [sphinx-rdt-theme](https://pypi.org/project/sphinx-rtd-theme/)

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.