mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-24 09:58:38 +01:00
Ignore .git directory as that shouldn't affect spec generation. Also, when we receive writes from the OS, wait a bit before re-generating the spec to clump together multiple writes rather than re-generating one after another and waiting for no more writes before serving the request. |
||
|---|---|---|
| .. | ||
| continuserv | ||
| speculator | ||
| basic.css | ||
| codehighlight.css | ||
| gendoc.py | ||
| matrix-org-gendoc.sh | ||
| nature.css | ||
| README | ||
Requirements:
- docutils (for converting RST to HTML)
- Jinja2 (for templating)
To generate the complete specification along with supporting documentation, run:
python gendoc.py
The output of this will be inside the "gen" folder.
Matrix.org only ("gen" folder has matrix.org tweaked pages):
./matrix-org-gendoc.sh /path/to/matrix.org/includes/nav.html