matrix-doc

History

Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver		2015-12-02 19:23:33 +00:00
..
continuserv	continuserv: serve multiple paths	2015-12-02 14:57:28 +00:00
css	Enable syntax highlighting for example http requests	2015-10-26 17:25:33 +00:00
speculator	Add trailing slashes to links	2015-12-01 15:58:15 +00:00
README	Restructure the first few sections.	2015-06-02 16:27:52 +01:00
add-matrix-org-stylings.sh	Generate API docs from swagger	2015-11-27 15:03:22 +00:00
gendoc.py	Embed client and server release numbers	2015-12-01 17:08:02 +00:00
generate-http-docs.sh	Consistently spell homeserver as homeserver	2015-12-02 19:23:33 +00: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