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

Kegan Dougal d3dca1f357 Sort keys alphabetically in tables. Sort event types alphabetically in sections.		10 years ago
..
internal	Sort keys alphabetically in tables. Sort event types alphabetically in sections.	10 years ago
templates	Sort out table layout and rejig where state_key is placed.	10 years ago
README.md	Add templating folder and stub files/templates.	10 years ago
build.py	Account for 'required' text when wrapping desc column.	10 years ago

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.