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 e401d3e262 Merge pull request #184 from matrix-org/daniel/splitspec Split spec into page-per-section		9 years ago
..
continuserv	Merge branch 'master' into daniel/continuservconcurrency	9 years ago
css	Enable syntax highlighting for example http requests	9 years ago
speculator	speculator: Allow spec viewing for multi-page spec	9 years ago
README	Restructure the first few sections.	10 years ago
add-matrix-org-stylings.sh	Generate API docs from swagger	9 years ago
gendoc.py	Split spec into page-per-section	9 years ago
generate-http-docs.sh	Generate API docs from swagger	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