Add sphinx-autobuild and Makefile
This commit is contained in:
parent
b54a737d94
commit
8063357ca5
|
@ -0,0 +1,12 @@
|
|||
.PHONY: clean docs livedocs
|
||||
|
||||
clean:
|
||||
rm -rf docs/_build
|
||||
|
||||
docs:
|
||||
sphinx-build docs docs/_build/html
|
||||
|
||||
livedocs:
|
||||
sphinx-autobuild docs docs/_build/html -a \
|
||||
--ignore '*.tmp' \
|
||||
--port 8181
|
|
@ -5,7 +5,12 @@ Prerequisites:
|
|||
* python 3.8+
|
||||
|
||||
To build:
|
||||
```
|
||||
```bash
|
||||
pip install -U -r requirements.txt
|
||||
sphinx-build docs docs/_build/html
|
||||
make docs
|
||||
```
|
||||
|
||||
Or with live reload:
|
||||
```bash
|
||||
make livedocs
|
||||
```
|
||||
|
|
|
@ -2,5 +2,6 @@ furo>=2022.6
|
|||
linkify-it-py>=2.0
|
||||
myst-parser>=0.17
|
||||
sphinx~=5.3.0
|
||||
sphinx-autobuild>=2021.3
|
||||
sphinx-design>=0.2
|
||||
sphinx-notfound-page>=0.8
|
||||
|
|
Loading…
Reference in New Issue