diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..59fa8f4 --- /dev/null +++ b/Makefile @@ -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 diff --git a/README.md b/README.md index a5176ae..59a4094 100644 --- a/README.md +++ b/README.md @@ -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 ``` diff --git a/requirements.txt b/requirements.txt index bdb6d14..c9ea28c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -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