merge main branch into refactor branch, update README.md
Browse files
README.md
CHANGED
|
@@ -81,7 +81,10 @@ sphinx-apidoc -f -o docs src
|
|
| 81 |
|
| 82 |
Then it's possible to generate the HTML pages
|
| 83 |
```bash
|
| 84 |
-
cd docs && make html
|
|
|
|
|
|
|
|
|
|
| 85 |
```
|
| 86 |
|
| 87 |
The static documentation it's now ready at the path `_build/html/index.html`.
|
|
|
|
| 81 |
|
| 82 |
Then it's possible to generate the HTML pages
|
| 83 |
```bash
|
| 84 |
+
cd docs && make html && ../
|
| 85 |
+
|
| 86 |
+
# to clean old files
|
| 87 |
+
cd docs && make clean html && cd ../
|
| 88 |
```
|
| 89 |
|
| 90 |
The static documentation it's now ready at the path `_build/html/index.html`.
|