From 290bc5ebdc3edaa28683af485cf4d1a6204d847e Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Tue, 29 Sep 2020 12:01:48 +0200 Subject: [PATCH] Document how to rebuild the documentation automatically on changes This speeds up the iteration workflow significantly when working on new pages. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 9f8471295..0eb1e2466 100644 --- a/README.md +++ b/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".