docs-matrix-spec

History

Kegan Dougal f71763b0d3 Implement relative title styles Templates don't know at what level they will be inserted. Previously, we hard-coded the title style which is not compatible with the build target system. Define a set of styles which will be replaced by the gendoc script when it encounters them: '<' : Make this title a sub-heading '/' : Make this title a heading at the same level '>' : Make this title a super-heading The build target system is now basically complete and functioning.		2015-09-22 13:08:15 +01:00
..
continuserv	Apparently tabs are A Thing	2015-09-18 15:15:55 +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
codehighlight.css	Turn on code highlighting for HTTP api responses and add a	2015-09-18 17:26:10 +01:00
gendoc.py	Implement relative title styles	2015-09-22 13:08:15 +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