wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
401 commits 4 branches 0 tags 17 MiB
Commit graph

46 commits

Author SHA1 Message Date
Kegan Dougal
c75fd6bcae Add HTTP API wip template. 2015-06-01 12:03:42 +01:00
Kegan Dougal
5795e1ceda Add profile API examples and extract examples for template usage. 2015-06-01 10:44:03 +01:00
Kegan Dougal
fe7ffafc15 Factor out json schema object processing since swagger uses it too. Hook swagger up. 2015-05-29 17:19:45 +01:00
Kegan Dougal
d090389d01 Start pre-processing swagger APIs before passing to sections. 2015-05-29 16:50:22 +01:00
Kegan Dougal
1dc3d82664 Load swagger APIs as templating units. Check sections return strings. 2015-05-29 15:58:33 +01:00
Kegan Dougal
f134728268 Link to msgtypes from the description of m.room.message. 2015-05-28 11:57:44 +01:00
Kegan Dougal
c3a298a5df Fix sort order for VoIP events. 2015-05-28 11:35:18 +01:00
Kegan Dougal
ac7ccfa622 Add {{presence_events}}. Factor out common code in MatrixSections. 2015-05-28 10:45:00 +01:00
Kegan Dougal
9abadaf7af Add {{presence_events}} template. 2015-05-28 10:36:02 +01:00
Kegan Dougal
e046402a4a Shift msgtype section order to have common (implemented) types first. 2015-05-27 16:51:07 +01:00
Kegan Dougal
6f330bd879 Gut the old msgtypes section and replace with {{msgtype_events}} 2015-05-27 16:42:01 +01:00
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.
 2015-05-27 16:30:11 +01:00
Kegan Dougal
06177740d4 Tweak how constants are represented. 2015-05-26 17:39:38 +01:00
Kegan Dougal
9d532f30e8 Add {{voip_events}}. Add more info on sections when asked via build.py -s 2015-05-26 17:32:51 +01:00
Kegsay
2a02b3494f Minor tweaks 2015-05-26 17:14:50 +01:00
Kegan Dougal
89083b3a86 Add {{spec_version}}. Update build.py module docs. 2015-05-26 17:09:30 +01:00
Kegsay
c721bb7e61 Update template readme 2015-05-26 16:47:53 +01:00
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.
 2015-05-26 16:20:15 +01:00
Kegan Dougal
8e1d6899c2 Start encapsulating Units too. Add debug option which controls logging. 2015-05-26 14:50:45 +01:00
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.
 2015-05-26 14:33:32 +01:00
Kegan Dougal
d3dca1f357 Sort keys alphabetically in tables. Sort event types alphabetically in sections. 2015-05-26 11:15:37 +01:00
Kegan Dougal
dc5c01607b Sort out table layout and rejig where state_key is placed. 2015-05-26 10:40:04 +01:00
Kegan Dougal
ed4ce6950c Template up common event fields from the 'core' json schema file. 2015-05-21 15:51:23 +01:00
Kegan Dougal
6dcbc40b63 Add common event field descriptions and template. 2015-05-21 15:41:34 +01:00
Kegan Dougal
54783a59c3 Put state_key info on same line as State Event text. 2015-05-21 15:09:46 +01:00
Kegan Dougal
4ea5da44d0 Include enum information. 2015-05-21 14:11:29 +01:00
Kegan Dougal
b6b8971491 Use ~ not - for event sections. 2015-05-21 14:02:32 +01:00
Kegan Dougal
73d84f3722 Add descriptions to state_keys. Add it into the template. 2015-05-21 13:31:08 +01:00
Kegan Dougal
989ea02219 s/Key/Content Key/ 2015-05-21 11:31:27 +01:00
Kegan Dougal
ea9c6496bb Account for 'required' text when wrapping desc column. 2015-05-21 11:27:54 +01:00
Kegan Dougal
a7f3d39da2 Use the entire event in the example JSON. Sort keys on JSON. 2015-05-21 11:12:43 +01:00
Kegan Dougal
6d3dd045a5 Line wrap 80 on desc, show the type of items in the array rather '[array]' 2015-05-21 10:43:10 +01:00
Kegan Dougal
a42a22028c Add event table template. Also inspect arrays for objects. 2015-05-21 10:39:54 +01:00
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)
 2015-05-21 09:46:14 +01:00
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
Kegan Dougal
75e7d09fc8 Remove newlines from json: move line wrapping to the template files. 2015-05-20 12:41:25 +01:00
Kegan Dougal
8f448a1764 Produce valid JSON (escape \n), add indent filter 2015-05-20 11:49:10 +01:00
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'.
 2015-05-20 11:19:32 +01:00
Kegan Dougal
1a65c051e8 Whitespace 2015-05-19 17:05:34 +01:00
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. 2015-05-19 16:49:20 +01:00
Kegan Dougal
c237c9010a Actually produce valid RST from the template 2015-05-19 15:54:24 +01:00
Kegan Dougal
8643b4aadd Update v1 paths, recursively print JSON format for arrays as well as objects. 2015-05-19 15:36:44 +01:00
Kegan Dougal
3c0b564977 Whine if there are missing variables that the template needs. 2015-05-19 15:24:55 +01:00
Kegan Dougal
7563f1058b Make the templating system work(!) 2015-05-19 15:03:31 +01:00
Kegan Dougal
4e64d9e340 Start fleshing out build script 2015-05-19 13:16:16 +01:00
Kegan Dougal
0b8b77697b Add templating folder and stub files/templates. 2015-05-19 11:22:33 +01:00