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

Richard van der Hoff b0ea6038c6 Move jekyll back out of matrix-doc again Having the jekyll assets here is a mistake, because they need to be versioned separately to the spec: we keep old versions of the spec, but they sometimes need to be restyled to match the latest website.		7 years ago
..
continuserv	Add continuserv index	8 years ago
contrib	Add a nix-shell environment suitable for building	8 years ago
css	Enable syntax highlighting for example http requests	9 years ago
speculator	Serve the api docs from the speculator	8 years ago
README.md	Add a nix-shell environment suitable for building	8 years ago
dump-swagger.py	Use matrix.org for swagger UI	8 years ago
gendoc.py	Hardcode client major version r0	7 years ago
generate-matrix-org-assets	Move jekyll back out of matrix-doc again	7 years ago
swagger-http-server.py	swagger-http-server: fix port param	8 years ago

README.md

Generating the HTML for the specification

Requirements:

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

Nix[2] users can enter an environment with the appropriate tools and dependencies available by invoking nix-shell contrib/shell.nix in this directory.

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:

It can be uploaded from your filesystem to an online editor/viewer such as http://editor.swagger.io/
You can run a local HTTP server by running ./swagger-http-server.py, and then view the documentation via an online viewer; for example, at http://petstore.swagger.io/?url=http://localhost:8000/api-docs.json
You can host the swagger UI yourself:
- download the latest release from https://github.com/swagger-api/swagger-ui
- copy the contents of the 'dist' directory alongside api-docs.json
- View the UI via your browser at http://<hostname>?url=api-docs.json

[1] http://swagger.io/ [2] https://nixos.org/nix/