blob: 9fd78df35d2f21fa34a9fe317dc985de8e7ab3a7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
# Documentation Generation
## Requirements
You'll need the following software:
- [Sphinx](http://www.sphinx-doc.org/en/master/index.html)
### Ubuntu
You can install the required software on Ubuntu with the following:
```
sudo apt install python3-sphinx
```
The second line can be omitted if you don't intend to build the PDF.
### MacOS
You can install the required software on MacOS with the following:
```
brew install sphinx-doc
```
The second line can be omitted if you don't intend to build the PDF.
## Building the Docs
You can generate the HTML documentation with
```
make
```
You can clean the build files and outputs with
```
make clean
```
|
