docs-matrix-spec

History

Kegan Dougal b6f0b67da6 Speed up continuserv 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.		2015-09-30 15:21:32 +01:00
..
continuserv	Speed up continuserv	2015-09-30 15:21:32 +01:00
speculator	Support viewing the spec at head	2015-09-29 12:41:07 +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
codehighlight.css	Turn on code highlighting for HTTP api responses and add a	2015-09-18 17:26:10 +01:00
gendoc.py	Add more logging and make logging context clearer	2015-09-23 15:36:13 +01:00
matrix-org-gendoc.sh	Add a README, spell matrix correctly.	2015-02-19 16:53:54 +00:00
nature.css	Delete rather than comment out the offending CSS	2015-09-30 10:54:06 +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