opensourcemirror
/
opnsense-docs
mirror of https://github.com/opnsense/docs.git
1
0
Fork 0
Code Issues Releases Wiki Activity

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.
This commit is contained in:
Monviech 2024-03-13 17:36:04 +01:00 committed by GitHub
parent 58e7286b3a
commit d272e953dd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

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