matrix-spec

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

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		10 years ago
..
continuserv	Error on failure of Watcher.Add	10 years ago
speculator	speculator: Document /	10 years ago
README	Restructure the first few sections.	11 years ago
basic.css	move gendoc to matrix-doc and make it work. rename tutorials section to match matrix.org structure	11 years ago
gendoc.py	Modify and enforce the file format/structure used	10 years ago
matrix-org-gendoc.sh	Add a README, spell matrix correctly.	11 years ago
nature.css	Add a CHANGELOG. Modify table CSS.	11 years ago

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