stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 18:29:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document how to rebuild the documentation automatically on changes

Browse Source 
This speeds up the iteration workflow significantly when working
on new pages.
This commit is contained in:
Hugo Locurcio
2020-09-29 12:02:50 +02:00
parent e3504184d3
commit 290bc5ebdc
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10
View File
@@ -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".