matrix
/
matrix-doc
mirror of https://github.com/matrix-org/matrix-doc.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
matrix-doc/scripts
History
Richard van der Hoff 49cd65dd58 Add a license to the spec 
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
 		2016-07-12 17:28:30 +01:00
..
continuserv Put each bit of spec in its own directory 2016-05-05 18:26:17 +01:00
css Enable syntax highlighting for example http requests 2015-10-26 17:25:33 +00:00
speculator Update the speculator to understand spec subdirs 2016-05-05 18:46:29 +01:00
README.md Add PyYAML to scripts/README.md 2016-06-11 14:10:21 +03:00
add-matrix-org-stylings.pl Replace hacky shell to do matrix styling with hacky perl 2016-05-04 00:01:54 +01:00
dump-swagger.py Add a license to the spec 2016-07-12 17:28:30 +01:00
gendoc.py Add a license to the spec 2016-07-12 17:28:30 +01:00
swagger-http-server.py Add a license to the spec 2016-07-12 17:28:30 +01:00

README.md

Generating the HTML for the specification

Requirements:

  • docutils (for converting RST to HTML)
  • Jinja2 (for templating)
  • PyYAML (for reading YAML files)

To generate the complete specification along with supporting documentation, run: python gendoc.py

The output of this will be inside the "scripts/gen" folder.

Matrix.org only ("gen" folder has matrix.org tweaked pages): ./matrix-org-gendoc.sh /path/to/matrix.org/includes/nav.html

Generating the Swagger documentation

Swagger[1] is a framework for representing RESTful APIs. We use it to generate interactive documentation for our APIs.

Swagger UI reads a JSON description of the API. To generate this file from the YAML files in the api folder, run: ./dump-swagger.py

By default, dump-swagger will write to scripts/swagger/api-docs.json.

To make use of the generated file, there are a number of options:

[1] http://swagger.io/