summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJos Verlinde <Jos_Verlinde@hotmail.com>2025-09-25 12:16:51 +0200
committerDamien George <damien@micropython.org>2025-09-26 00:07:58 +1000
commit10b3d96b607404e5d73cb43c9d587ddb1f5665fc (patch)
treec36fbc1f349d65c371306199127f45f58ff62f52
parent74270df9acbb619ce58830eb6940b3366d372526 (diff)
docs/README: Document sphinx-autobuild for local preview.
Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
-rw-r--r--docs/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index 11ad32ddb..9b3b036e0 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -24,6 +24,21 @@ In `micropython/docs`, build the docs:
You'll find the index page at `micropython/docs/build/html/index.html`.
+Documentation autobuild
+-----------------------
+
+For a more convenient development experience, you can use `sphinx-autobuild`
+to automatically rebuild and serve the documentation when you make changes:
+
+ pip install sphinx-autobuild
+
+Then run from the `micropython/docs` directory:
+
+ sphinx-autobuild . build/html
+
+This will start a local web server (typically at `http://127.0.0.1:8000`)
+and automatically rebuild the documentation whenever you save changes to the source files.
+
Having readthedocs.org build the documentation
----------------------------------------------