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

Kegsay e5559e4ea5 Merge pull request #106 from matrix-org/erikj/newline_gendoc_STOP_BEING_CRANKY gendoc should just add newlines rather than complaining about the lack thereof		9 years ago
..
continuserv	Speed up continuserv	9 years ago
speculator	Add a note on building the speculator	9 years ago
README	Restructure the first few sections.	10 years ago
basic.css	move gendoc to matrix-doc and make it work. rename tutorials section to match matrix.org structure	10 years ago
codehighlight.css	Turn on code highlighting for HTTP api responses and add a	9 years ago
gendoc.py	gendoc should just add newlines rather than complaining about the lack thereof	9 years ago
matrix-org-gendoc.sh	special css for spec/howto	9 years ago
nature.css	Merge branch 'master' into module-presence	9 years ago

README

Requirements:
 - docutils (for converting RST to HTML)
 - Jinja2 (for templating)

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

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

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