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

60 commits

Author SHA1 Message Date
Kegan Dougal
1da64db302 Use relative depths for groups instead of absolute ones 
This means the group can be agnostic to how deeply nested it is,
improving reusability of groups.
 2015-09-23 14:29:37 +01:00
Kegan Dougal
16693a644a Various review fixes 2015-09-22 16:59:49 +01:00
Kegan Dougal
b21859836d Print stdout of build.py in verbose mode 2015-09-22 16:11:16 +01:00
Kegan Dougal
f71763b0d3 Implement relative title styles 
Templates don't know at what level they will be inserted. Previously, we
hard-coded the title style which is not compatible with the build target
system. Define a set of styles which will be replaced by the gendoc script
when it encounters them:
 '<' : Make this title a sub-heading
 '/' : Make this title a heading at the same level
 '>' : Make this title a super-heading

The build target system is now basically complete and functioning.
 2015-09-22 13:08:15 +01:00
Kegan Dougal
067363c629 Get the desired title levels right; print out the actual level used to stdout 2015-09-21 17:21:08 +01:00
Kegan Dougal
d5e0115e42 Merge branch 'master' into spec-restructure-modules 2015-09-21 16:55:24 +01:00
Kegan Dougal
65ce95249f cat the spec according to the build target. Remove old checks as they are now obsolete since we don't care about the filename 2015-09-21 16:54:30 +01:00
Kegan Dougal
8590cc84b5 Process and extract targets in gendoc.py 2015-09-21 15:33:28 +01:00
Mark Haines
6b5b8432b3 Turn on code highlighting for HTTP api responses and add a 
code highlighting stylesheet for the specification.
 2015-09-18 17:26:10 +01:00
Kegsay
5fbd534713 Merge pull request #51 from matrix-org/daniel/gendoc 
Print errors to stderr
 2015-09-18 15:50:56 +01:00
Kegan Dougal
cf8abdafd4 Fix PR comments 2015-09-18 15:42:49 +01:00
Kegan Dougal
ba4998a62b Apparently tabs are A Thing 2015-09-18 15:15:55 +01:00
Kegan Dougal
427e4c8b1b Log port being listened on 2015-09-18 15:15:55 +01:00
Kegan Dougal
1f6b12b3e8 Modify and enforce the file format/structure used 
Convert the file format to be of the form ##_##_something.rst where the
first ## is the top-level section number and the second ## is the
second-level section number, e.g. 07_01_push_cs_api.rst means
Section 7.1 - This is now enforced in gendoc.py along with the title line
style that should be used (= for top-level, - for 2nd level) which will
give helpful suggestions if you trip up. This feels much more intuitive
now looking in /specification
 2015-09-18 11:43:53 +01:00
Kegan Dougal
06e46c1899 Fix on a better numbering format 2015-09-18 11:20:34 +01:00
Kegan Dougal
ef473b4161 Start enforcing title styles 
This depends on the number of the file.
 2015-09-18 11:05:48 +01:00
Daniel Wagner-Hall
08defafd98 Print errors to stderr 
This means that continuserv will actually display them
 2015-09-18 10:26:13 +01:00
Kegan Dougal
ad26b7f8cb Fix a subtle rendering bug when catting spec sections 
Throw in gendoc.py if a spec section doesn't end with \n\n

There needs to be TWO new lines at the end of each spec section else the
title of the next section merges into the last paragraph of the earlier
section. This happens without rst2html producing a warning, and results
in the section heading of a file disappearing(!)
 2015-09-18 10:03:58 +01:00
Kegan Dougal
9c3a333a6d Apparently tabs are A Thing 2015-09-17 15:49:01 +01:00
Kegan Dougal
9b18fd252e Log port being listened on 2015-09-17 15:46:37 +01:00
Daniel Wagner-Hall
21411309e0 Fix chdir path 2015-09-15 16:27:10 +01:00
Mark Haines
c3eab1cc3c Set the current working directory in gendoc.py to the script directory as that is where it expects to be run 2015-09-15 11:41:40 +01:00
Daniel Wagner-Hall
d251f791fb speculator: Document / 2015-09-11 17:15:33 +01:00
Daniel Wagner-Hall
f9ef934625 Merge branch 'master' into speculator-list 
Conflicts:
	scripts/speculator/main.go
 2015-09-11 15:31:32 +01:00
Kegsay
e4f4670260 Merge pull request #44 from matrix-org/speculator-errs 
speculator: Don't ignore errors
 2015-09-11 15:30:15 +01:00
Daniel Wagner-Hall
b6dab0009d speculator: Don't ignore errors 2015-09-11 14:43:26 +01:00
Daniel Wagner-Hall
20f0284155 speculator: Unified diff for rst diff 2015-09-11 14:40:52 +01:00
Daniel Wagner-Hall
ba780a589a speculator: Add list-pull-request functionality 2015-09-11 14:40:08 +01:00
Daniel Wagner-Hall
fef97802b7 Merge pull request #39 from matrix-org/speculator 
speculator: Tool to preview spec pull requests
 2015-09-11 12:43:33 +01:00
Daniel Wagner-Hall
bf318ffcd5 Add HTTP endpoints to README 2015-09-11 12:42:41 +01:00
Daniel Wagner-Hall
ca7dd49dc6 speculator: Add /healthz endpoint 2015-09-10 17:14:53 +01:00
Daniel Wagner-Hall
708f281270 Add comments about auth 2015-09-10 17:09:44 +01:00
Kegsay
c427c579cb Merge pull request #37 from matrix-org/continuserv 
continuserv: Server to live serve local updates to the spec
 2015-09-10 16:17:33 +01:00
Daniel Wagner-Hall
c29aef362e Error on failure of Watcher.Add 2015-09-10 15:45:21 +01:00
Daniel Wagner-Hall
6ac519d9dc Log on file updates 2015-09-10 14:25:37 +01:00
Daniel Wagner-Hall
6e86cb34d2 continuserv: Adding README 2015-09-10 14:25:23 +01:00
Daniel Wagner-Hall
34091038f3 speculator: Tool to preview spec pull requests 
Not the prettiest thing in the world, and horribly unperformant, but
useful :)
 2015-09-10 14:19:06 +01:00
Daniel Wagner-Hall
cdc06a8bf1 Document --nodelete 2015-09-10 13:53:38 +01:00
Daniel Wagner-Hall
a74fb54053 Correct comment 2015-09-10 13:44:41 +01:00
Daniel Wagner-Hall
ad595aea45 Optionally don't delete intermediate rst files 
Useful for debugging
Hackily hackily implemented :)
 2015-09-10 13:21:08 +01:00
Daniel Wagner-Hall
e30272733b continuserv: Make port flag-specified 2015-09-10 11:29:16 +01:00
Daniel Wagner-Hall
c4acee3bcb continuserv: Live serves updates to the spec 2015-09-10 11:16:31 +01:00
Daniel Wagner-Hall
0414ff4cc3 Output error if command fails 2015-09-07 16:27:18 +01:00
Kegan Dougal
e572cc662a Restructure the first few sections. 
Remove unecessary sections; put presnece/profile sections on the right level.
Move Living Standard warning to the top of the Introduction section.
 2015-06-02 16:27:52 +01:00
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.
 2015-06-01 17:48:16 +01:00
Kegan Dougal
f9710a6e17 Add help blurb to gendoc.py 2015-05-28 14:16:57 +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
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
dc5c01607b Sort out table layout and rejig where state_key is placed. 2015-05-26 10:40:04 +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