From d272e953dd4bf4ab35fd07fed59c9077f63f6f49 Mon Sep 17 00:00:00 2001 From: Monviech <79600909+Monviech@users.noreply.github.com> Date: Wed, 13 Mar 2024 17:36:04 +0100 Subject: [PATCH] Update README.md (#544) Hint the use of sphinx autobuild in Readme.md. It's a great tool to see a live preview while writing docs and editing them. The instant feedback really helps to get work done faster. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index a91d64b7..86419b70 100644 --- a/README.md +++ b/README.md @@ -61,3 +61,15 @@ make html ``` (```make clean``` to flush) + +#### Live preview of HTML documents + +Use `sphinx-autobuild` to track `source` for changes and get a live preview served via ``http://localhost:8000``. + +``` +pip[3] install sphinx-autobuild +``` + +``` +sphinx-autobuild source html +```