Browse Source

Document how to rebuild the documentation automatically on changes

This speeds up the iteration workflow significantly when working
on new pages.
Hugo Locurcio 4 years ago
parent
commit
290bc5ebdc
1 changed files with 10 additions and 0 deletions
  1. 10 0
      README.md

+ 10 - 0
README.md

@@ -125,6 +125,16 @@ pip install -r requirements.txt
 
 Then do `make html` like above.
 
+### Rebuilding automatically on changes
+
+To build the documentation every time you save your changes, install
+[watchexec](https://github.com/watchexec/watchexec) then run the following
+command in this directory:
+
+```sh
+watchexec make html
+```
+
 ## License
 
 At the exception of the `classes/` folder, all the content of this repository is licensed under the Creative Commons Attribution 3.0 Unported license ([CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community".