fa0cd4ff9d
I don't see a point in using [line blocks][1] anywhere in the documentation. Note that mandoc consequently renders it with a `<pre>` tag which looks ugly on [man.archlinux.org][2]. Also simplified the URL in `index.rst` which can be written verbatim without any special markup. See this [archmanweb issue][3] for details. [1]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [2]: https://man.archlinux.org/man/archinstall.1 [3]: https://gitlab.archlinux.org/archlinux/archmanweb/-/issues/49#note_213730 Co-authored-by: Jakub Klinkovský <1289205+lahwaacz@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| _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.