40715549cb
* According to https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html - extension = [] needs to be added too * Fixed wonky indentation |
||
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| archinstall | ||
| cli_parameters/config | ||
| 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.