1f6b12b3e8
Convert the file format to be of the form ##_##_something.rst where the first ## is the top-level section number and the second ## is the second-level section number, e.g. 07_01_push_cs_api.rst means Section 7.1 - This is now enforced in gendoc.py along with the title line style that should be used (= for top-level, - for 2nd level) which will give helpful suggestions if you trip up. This feels much more intuitive now looking in /specification |
||
|---|---|---|
| .. | ||
| continuserv | ||
| speculator | ||
| basic.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