wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
docs-matrix-spec/templating
History
Kegan Dougal c237c9010a Actually produce valid RST from the template
2015-05-19 15:54:24 +01:00
..
internal Update v1 paths, recursively print JSON format for arrays as well as objects. 2015-05-19 15:36:44 +01:00
templates Actually produce valid RST from the template 2015-05-19 15:54:24 +01:00
build.py Actually produce valid RST from the template 2015-05-19 15:54:24 +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.