Commit Graph

152 Commits (c05da871ca5f427c954bed0ce440b5f107cd3126)

Author SHA1 Message Date
Kegan Dougal bb9537b824 Add a CHANGELOG. Modify table CSS.
Hook up templating system to read the CHANGELOG for version and changelog info.
Modified nature.css to make it clearer on table headings/sub-headings. Use the
full _matrix/client path on title links to make it clear it is for v1.
10 years ago
Kegan Dougal 8a676a2b9d Add sortFn for profile HTTP API. Add combined profile HTTP API. 10 years ago
Kegan Dougal 704cd14030 Add in response format for APIs. Standardise on 'key' rather than 'name'. 10 years ago
Kegan Dougal f6c98f41e9 Use table subsections for param locations instead of an extra column. 10 years ago
Kegan Dougal ba6ce16509 Modify how descriptions are shown. Add profile API descriptions. 10 years ago
Kegan Dougal 862f5a3a53 Add structure for adding examples to HTTP APIs.
Use 'x-example' to add examples to parameters which are not in 'body' (swagger
doesn't define that currently). Add profile API examples. Add necessary glue
and templates to make it all work.
10 years ago
Kegan Dougal c75fd6bcae Add HTTP API wip template. 10 years ago
Kegan Dougal 5795e1ceda Add profile API examples and extract examples for template usage. 10 years ago
Kegan Dougal fe7ffafc15 Factor out json schema object processing since swagger uses it too. Hook swagger up. 10 years ago
Kegan Dougal d090389d01 Start pre-processing swagger APIs before passing to sections. 10 years ago
Kegan Dougal 1dc3d82664 Load swagger APIs as templating units. Check sections return strings. 10 years ago
Kegan Dougal f134728268 Link to msgtypes from the description of m.room.message. 10 years ago
Kegan Dougal c3a298a5df Fix sort order for VoIP events. 10 years ago
Kegan Dougal ac7ccfa622 Add {{presence_events}}. Factor out common code in MatrixSections. 10 years ago
Kegan Dougal 9abadaf7af Add {{presence_events}} template. 10 years ago
Kegan Dougal e046402a4a Shift msgtype section order to have common (implemented) types first. 10 years ago
Kegan Dougal 6f330bd879 Gut the old msgtypes section and replace with {{msgtype_events}} 10 years ago
Kegan Dougal 59f856c7e6 Factor out ImageInfo into a core type. Refer to that in other msgtypes.
Add templating for msgtypes. ImageInfo core type is not referred to for
m.image in order for the ImageInfo table to render for it.
10 years ago
Kegan Dougal 06177740d4 Tweak how constants are represented. 10 years ago
Kegan Dougal 9d532f30e8 Add {{voip_events}}. Add more info on sections when asked via build.py -s 10 years ago
Kegsay 2a02b3494f Minor tweaks 10 years ago
Kegan Dougal 89083b3a86 Add {{spec_version}}. Update build.py module docs. 10 years ago
Kegsay c721bb7e61 Update template readme 10 years ago
Kegan Dougal 5b31c442f5 Completely split up the templating system from the Matrix Spec template code.
The two are now linked together in build.py by specifying the input module.
Updated gendoc.py to specify the right module.
10 years ago
Kegan Dougal 8e1d6899c2 Start encapsulating Units too. Add debug option which controls logging. 10 years ago
Kegan Dougal 96671ce833 Use the templating system to set {{git_version}}. Restructure sections code.
Restructured the sections code to be slightly more encapsulated than before.
This will be expanded to more clearly separate the templating system from
the specific implementation of the spec templates.
10 years ago
Kegan Dougal d3dca1f357 Sort keys alphabetically in tables. Sort event types alphabetically in sections. 10 years ago
Kegan Dougal dc5c01607b Sort out table layout and rejig where state_key is placed. 10 years ago
Kegan Dougal ed4ce6950c Template up common event fields from the 'core' json schema file. 10 years ago
Kegan Dougal 6dcbc40b63 Add common event field descriptions and template. 10 years ago
Kegan Dougal 54783a59c3 Put state_key info on same line as State Event text. 10 years ago
Kegan Dougal 4ea5da44d0 Include enum information. 10 years ago
Kegan Dougal b6b8971491 Use ~ not - for event sections. 10 years ago
Kegan Dougal 73d84f3722 Add descriptions to state_keys. Add it into the template. 10 years ago
Kegan Dougal 989ea02219 s/Key/Content Key/ 10 years ago
Kegan Dougal ea9c6496bb Account for 'required' text when wrapping desc column. 10 years ago
Kegan Dougal a7f3d39da2 Use the entire event in the example JSON. Sort keys on JSON. 10 years ago
Kegan Dougal 6d3dd045a5 Line wrap 80 on desc, show the type of items in the array rather '[array]' 10 years ago
Kegan Dougal a42a22028c Add event table template. Also inspect arrays for objects. 10 years ago
Kegan Dougal 0899e0b772 Update event schema parsing.
The templating system now parses event schemas into a form which
can be easily dumped into multiple tables (for nested object types)
10 years ago
Kegan Dougal 02c44a889e Remove stuff from 20_events.rst and replace with {{room_events}}. Update gendoc to call build.py for template vars. 10 years ago
Kegan Dougal 75e7d09fc8 Remove newlines from json: move line wrapping to the template files. 10 years ago
Kegan Dougal 8f448a1764 Produce valid JSON (escape \n), add indent filter 10 years ago
Kegan Dougal 2e5809a68e Make build.py accept generic files for template var substitutions.
This allows us to incrementally convert sections of the spec to use this
templating system. E.g. './build.py ../specification/20_events.rst' where
that .rst file has {{room_events}} in it somewhere. Add ability to show
a list of valid template vars to use (e.g. room_events) by running
'./build.py --show-template-vars'.
10 years ago
Kegan Dougal 1a65c051e8 Whitespace 10 years ago
Kegan Dougal c61223fb27 Add title/desc to lots of event schemas, add missing keys (e.g. avatar_url, displayname), add required keys section to spec. 10 years ago
Kegan Dougal c237c9010a Actually produce valid RST from the template 10 years ago
Kegan Dougal 8643b4aadd Update v1 paths, recursively print JSON format for arrays as well as objects. 10 years ago
Kegan Dougal 3c0b564977 Whine if there are missing variables that the template needs. 10 years ago
Kegan Dougal 7563f1058b Make the templating system work(!) 10 years ago
Kegan Dougal 4e64d9e340 Start fleshing out build script 10 years ago
Kegan Dougal 0b8b77697b Add templating folder and stub files/templates. 10 years ago