From 10b3d96b607404e5d73cb43c9d587ddb1f5665fc Mon Sep 17 00:00:00 2001 From: Jos Verlinde Date: Thu, 25 Sep 2025 12:16:51 +0200 Subject: [PATCH] docs/README: Document sphinx-autobuild for local preview. Signed-off-by: Jos Verlinde --- docs/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/README.md b/docs/README.md index 11ad32ddb5..9b3b036e06 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 ----------------------------------------------