docs-matrix-spec

History

Daniel Wagner-Hall 559747e77a speculator: Sent Content-Type: text/html header Go is auto-detecting that this is XML (because for some reason we generate XHTML), and serving it with a Content-Type header text/xml. This causes the browser to render it as XHTML, which gives interesting quirks like extra newlines. This forces the browser to interpret it as HTML. What we should probably do instead of stop generating XHTML and start generating HTML. But in the mean time, this will fix the rendering issues.		2015-11-05 19:18:28 +00:00
..
continuserv	Speed up continuserv	2015-09-30 15:21:32 +01:00
css	Enable syntax highlighting for example http requests	2015-10-26 17:25:33 +00:00
speculator	speculator: Sent Content-Type: text/html header	2015-11-05 19:18:28 +00:00
gendoc.py	Move css into a css subdirectory.	2015-10-23 11:58:06 +01:00
matrix-org-gendoc.sh	special css for spec/howto	2015-10-12 19:57:41 +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