File tree Expand file tree Collapse file tree 1 file changed +26
-3
lines changed Expand file tree Collapse file tree 1 file changed +26
-3
lines changed Original file line number Diff line number Diff line change 22
33## Build the docs
44
5+ - Make sure in ` docs ` directory
6+
7+ ``` bash
8+ cd docs
9+ ```
10+
11+ - Install the dependencies:
12+
513``` bash
6- # Install dependencies.
714pip install -r ../requirements/docs.txt
15+ ```
16+
17+ - Clean the previous build (optional but recommended):
818
9- # Build the docs.
19+ ``` bash
1020make clean
21+ ```
22+
23+ - Generate the HTML documentation:
24+
25+ ``` bash
1126make html
1227```
1328
1429## Open the docs with your browser
1530
31+ - Serve the documentation locally:
32+
1633``` bash
1734python -m http.server -d build/html/
1835```
1936
20- Launch your browser and open localhost:8000.
37+ This will start a local server at http://localhost:8000 . You can now open your browser and view the documentation.
38+
39+ If port 8000 is already in use, you can specify a different port, for example:
40+
41+ ``` bash
42+ python -m http.server 3000 -d build/html/
43+ ```
You can’t perform that action at this time.
0 commit comments