Skip to content

Commit d272e95

Browse files
authored
Update README.md (opnsense#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.
1 parent 58e7286 commit d272e95

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,15 @@ make html
6161
```
6262

6363
(```make clean``` to flush)
64+
65+
#### Live preview of HTML documents
66+
67+
Use `sphinx-autobuild` to track `source` for changes and get a live preview served via ``http://localhost:8000``.
68+
69+
```
70+
pip[3] install sphinx-autobuild
71+
```
72+
73+
```
74+
sphinx-autobuild source html
75+
```

0 commit comments

Comments
 (0)