docs-matrix-spec

History

Matthew Hodgson 598e9b3113 big reshuffle: * try to make 00_basis slightly more accessible and less terse * move CS API before Events, as it's meaningless to dive into specific events if you haven't been introduced to how the CS API works * Try to improve the beginning of the CS API by merging back in some of kegan's original v1 content (which has subsequently been deleted somewhere along the line?) * document m.presence event consistently * move typing from drafts to spec * move push stuff from drafts to spec ...and lots of other stuff move push & typing from drafts into main spec.		2015-03-16 00:14:03 -04: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	big reshuffle:	2015-03-16 00:14:03 -04:00
matrix-org-gendoc.sh	Add a README, spell matrix correctly.	2015-02-19 16:53:54 +00:00
nature.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
README	Minor tweak for matrix.org example	2015-02-19 17:16:59 +00:00

README

Requirements:
 - docutils (for converting RST to HTML) 

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