diff --git a/.gitignore b/.gitignore index cb706d671bed348b29888f06e8b821173e145b2f..8e15e6b5f34019b4d4224077995af9ec5c46da4c 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,6 @@ __pycache__ # Python .venv + +# sphinx +docs/_build/ diff --git a/README.md b/README.md index 8daba1a408c2dc4c36e4bfcaf65ee5ae183d0298..32bf3861af536d3bf7721d8102e9d47a48aa2c04 100644 --- a/README.md +++ b/README.md @@ -248,3 +248,19 @@ Then write and read from each side: uart.write("hiiii") uart.read(5) ``` + +### Documentation + +To build sphinx docs: + +``` +cd docs +make html +firefox _build/html/index.html +``` + +To continuously build on change: + +``` +watchexec make html +```