blob: b8fe7e32c24767c6972a611ab48da0b8f23af133 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
Build documentation
===================
ArGaze has a standard MkDocs layout which is built by Read the Docs. You can build and view this documentation project locally.
!!! note
*Consider that all inline commands below have to be executed at the root of ArGaze package folder.*
Install required Python dependencies (MkDocs etc.):
```console
pip install -r docs/requirements.in
```
Run the mkdocs development server:
```console
mkdocs serve
```
Export the mkdocs site:
```console
mkdocs build
```
|
