Lerking/micropython
1
0
Fork 0
mirror of https://github.com/micropython/micropython.git synced 2026-01-05 03:30:14 +01:00
Code Issues Actions 52 Packages Projects Releases Wiki Activity

docs/README: Document sphinx-autobuild for local preview.

Browse Source 
Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
This commit is contained in:
Jos Verlinde
2025-09-25 12:16:51 +02:00
committed by Damien George
parent 74270df9ac
commit 10b3d96b60
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/README.md
View File

@@ -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
----------------------------------------------