Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-20 16:38:37 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
matrix-spec/scripts
History
Kegan Dougal 1f6b12b3e8 Modify and enforce the file format/structure used 
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
2015-09-18 11:43:53 +01:00
..
continuserv Error on failure of Watcher.Add 2015-09-10 15:45:21 +01:00
speculator speculator: Document / 2015-09-11 17:15:33 +01:00
basic.css move gendoc to matrix-doc and make it work. rename tutorials section to match matrix.org structure 2014-10-17 02:33:35 +01:00
gendoc.py Modify and enforce the file format/structure used 2015-09-18 11:43:53 +01:00
matrix-org-gendoc.sh Add a README, spell matrix correctly. 2015-02-19 16:53:54 +00:00
nature.css Add a CHANGELOG. Modify table CSS. 2015-06-01 17:48:16 +01:00
README Restructure the first few sections. 2015-06-02 16:27:52 +01:00

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