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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
Install Doxygen:
```
brew install doxygen
```
Install Python packages:
```
pip install -r requirements.txt
```
Build the docs from `mlx/docs/`
```
doxygen && make html
```
View the docs by running a server in `mlx/docs/build/html/`:
```
python -m http.server <port>
```
and point your browser to `http://localhost:<port>`.
Check-out the `gh-pages` branch (`git switch gh-pages`) and build
the docs. Then force add the `build/html` directory:
`git add -f build/html`
Commit and push the changes to the `gh-pages` branch.
To enable live refresh of docs while writing:
Install sphinx autobuild
```
pip install sphinx-autobuild
```
Run auto build on docs/src folder
```
sphinx-autobuild ./src ./build/html
```