matrix-spec

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver		9 years ago
..
continuserv	continuserv: serve multiple paths	9 years ago
css	Enable syntax highlighting for example http requests	9 years ago
speculator	Add trailing slashes to links	9 years ago
README	Restructure the first few sections.	9 years ago
add-matrix-org-stylings.sh	Generate API docs from swagger	9 years ago
gendoc.py	Embed client and server release numbers	9 years ago
generate-http-docs.sh	Consistently spell homeserver as homeserver	9 years ago

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