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 1f5b6271f2 Generate swagger-ui output for client-server API Depends on: https://github.com/matrix-org/matrix-doc/pull/212 https://github.com/matrix-org/matrix-doc/pull/208 https://github.com/matrix-org/matrix-doc/pull/207 for the actual rendered output to not throw javascript errors at runtime.		9 years ago
..
continuserv	continuserv: serve multiple paths	9 years ago
css	Enable syntax highlighting for example http requests	9 years ago
speculator	Merge pull request #216 from matrix-org/rav/fix_speculator_redirects	9 years ago
README	Restructure the first few sections.	10 years ago
add-matrix-org-stylings.sh	Generate swagger-ui output for client-server API	9 years ago
dump-swagger.py	Generate swagger-ui output for client-server API	9 years ago
gendoc.py	Embed client and server release numbers	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