docs-matrix-spec

History

Kegan Dougal 02c44a889e Remove stuff from 20_events.rst and replace with {{room_events}}. Update gendoc to call build.py for template vars.		2015-05-20 15:40:06 +01:00
..
internal	Remove stuff from 20_events.rst and replace with {{room_events}}. Update gendoc to call build.py for template vars.	2015-05-20 15:40:06 +01:00
templates	Remove newlines from json: move line wrapping to the template files.	2015-05-20 12:41:25 +01:00
build.py	Remove stuff from 20_events.rst and replace with {{room_events}}. Update gendoc to call build.py for template vars.	2015-05-20 15:40:06 +01:00
README.md	Add templating folder and stub files/templates.	2015-05-19 11:22:33 +01:00

README.md

This folder contains the templates and templating system for creating the spec. We use the templating system Jinja2 in Python. This was chosen over other systems such as Handlebars.js and Templetor because we already have a Python dependency on the spec build system, and Jinja provides a rich set of template operations beyond basic control flow.

Installation

 $ pip install Jinja2

Running

To build the spec:

 $ python build.py

This will output spec.rst which can then be fed into the RST->HTML converter located in matrix-doc/scripts.