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

203 commits

Author SHA1 Message Date
Ben Parsons
d338f18927 handle EOF gracefully when searching for Authors and PRs 2018-05-15 15:22:03 +01:00
Ben Parsons
f1cc26dfd7 sort output by Created date per-table 2018-05-15 11:59:34 +01:00
Ben Parsons
b8f38b21a7 update introductory text 2018-05-14 14:25:12 +01:00
Ben Parsons
e87f1f2619 include PRs in tables 2018-05-14 11:32:40 +01:00
Ben Parsons
3b4e56c4e0 handle dd/mm/yyyy and yyyy-mm-dd dates in text 2018-05-14 09:48:54 +01:00
Ben Parsons
3b84de383c cleanup and include all content 2018-05-12 10:30:52 +01:00
Ben Parsons
cbdd33a5f5 single authors and shepherds link correctly 2018-05-11 21:23:06 +01:00
Ben Parsons
73b7faddd4 handle multiple Google Docs 2018-05-11 20:47:27 +01:00
Ben Parsons
866b0b6348 I mostly play with ascii art 2018-05-10 16:02:55 +01:00
Ben Parsons
dc2b53318b prettify ID column 2018-05-09 11:32:31 +01:00
Ben Parsons
a78f7b38e9 generator is now usable 2018-05-08 15:35:46 +01:00
Ben Parsons
c58dc59ffe separate tables by label 2018-05-08 14:43:06 +01:00
Ben Parsons
1f7fbefd53 start using a table 2018-05-08 12:17:38 +01:00
Ben Parsons
e18aa30fd2 start generating new proposals page 2018-05-02 13:47:01 +01:00
Richard van der Hoff
f04b17f1c9 Fix path to fsnotify 
Apparently this should be referred to as gopkg.in/fsnotify/fsnotify.v1. I'm not
sure what has changed to stop the old format working.
 2018-03-27 11:27:23 +01:00
Richard van der Hoff
8e97ec8bad make the speculator work for rick 2018-03-14 17:52:10 +00:00
Richard van der Hoff
9150ba0dce Improve error output from failing to parse examples 2018-03-06 11:09:33 +00:00
Richard van der Hoff
a36bd1a6d2 Make build fail if gendoc fails 
(cf https://github.com/matrix-org/matrix-doc/issues/1146)
 2018-03-06 11:03:52 +00:00
Richard van der Hoff
87d90ab58a gendoc: improve title line matching 
This makes it possible to include tables etc without the script trying to turn
them into titles.
 2017-11-22 22:44:04 +00:00
Maxime Dor
1045bc721d Document federation version endpoint 2017-11-15 04:16:30 +01:00
Richard van der Hoff
427e0bb83b make jenkins and travis use a common script 2017-11-14 19:19:58 +00:00
Richard van der Hoff
202a265d85 Config for travis-ci 2017-11-14 13:12:38 +00:00
Richard van der Hoff
0cbf533625 Use petstore for continuserv swagger docs 
Matrix.org's swagger browser is behind https, which means it can't read the
swagger from a continuserv on http. Use the petstore instead.
 2017-11-14 13:02:43 +00:00
Richard van der Hoff
a38d4fc68e Move templating into scripts dir 
There's no real need for this to be at the top level.
 2017-11-08 08:37:56 +00:00
Richard van der Hoff
e7772af5c3 Supporting-docs now in matrix.org repo. 2017-11-06 14:57:04 +00:00
Richard van der Hoff
cc6b16b63c Generate the swagger for export 
We may as well generate the unstable version of the C-S swagger.
 2017-10-25 12:09:08 +01:00
Richard van der Hoff
d6f892f894 continuserv, speculator: update dump-swagger call 
dump-swagger now expects -o before its output path
 2017-10-25 12:05:31 +01:00
Richard van der Hoff
56c3e5a627 README.rst: Add notes on how to build the spec 2017-10-25 09:57:02 +01:00
Richard van der Hoff
834a3d78a8 Add a pip requirements file for the scripts 2017-10-25 09:54:21 +01:00
Richard van der Hoff
986c9d99a0 Improve arg parsing in dump-swagger 2017-10-25 08:05:50 +01:00
Richard van der Hoff
0dfff6b190 Simplify dump_swagger 
We don't need most of the templating stuff. All we have to do is merge together
the swagger files, and resolve references.
 2017-09-27 08:04:24 +01:00
Richard van der Hoff
2454598926 Speculator: include API docs links for branches 2017-09-26 15:23:00 +01:00
Richard van der Hoff
13d3293378 Fix version-extraction regexp 
Fixes https://github.com/matrix-org/matrix-doc/issues/982
 2017-09-18 13:48:35 +01:00
Richard van der Hoff
b0ea6038c6 Move jekyll back out of matrix-doc again 
Having the jekyll assets here is a mistake, because they need to be versioned
separately to the spec: we keep old versions of the spec, but they sometimes
need to be restyled to match the latest website.
 2017-08-03 15:49:17 +01:00
Richard van der Hoff
8a66b1a68b Build the spec as part of the build 2017-08-03 00:18:07 +01:00
Richard van der Hoff
0af06291fe Hardcode client major version r0 2017-08-02 21:58:52 +01:00
Richard van der Hoff
986e51cf35 Gendoc: allow overriding the dest dir 2017-08-02 21:48:07 +01:00
Richard van der Hoff
9d2a93ad7b Run jekyll as part of the matrix-doc build 
- this saves us having to run it manually on the web server.
 2017-08-02 16:20:46 +01:00
Richard van der Hoff
934dd4754c swagger-http-server: fix port param 
it needs to be an int, not a list
 2017-04-19 16:10:53 +01:00
Richard van der Hoff
2ec43a5948 Add continuserv index 
Oops, forgot this when adding support for the API docs to continuserv in
bfb65d8.
 2016-10-14 17:57:07 +01:00
Richard van der Hoff
d41438605d Use matrix.org for swagger UI 
In the swagger UI, default to matrix.org rather than localhost, to make the UI
more useful.
 2016-10-14 17:56:26 +01:00
Richard van der Hoff
bfb65d8ceb Serve the API docs with continuserv 2016-10-13 23:54:08 +01:00
Richard van der Hoff
1320a86cbe Serve the api docs from the speculator 
There are a few parts to this:

* when we generate the spec for a particular git sha, also run the script which
  turns our yaml api descriptions into a swagger json file.

* tweak serveSpec to add another header when serving the generated json.

* add a link to the generated index which will (via js hackery) redirect to our
  hosted swagger UI at http://matrix.org/docs/api/client-server, with a "url"
  query-param pointing at the generated json.

Also, factor makeTempDir out of gitClone, so that we can give clearer log lines.
 2016-10-03 12:36:46 +01:00
Richard van der Hoff
459f4b953d swagger-http-server: add a --port argument 2016-09-27 12:18:01 +01:00
Oddvar Lovaas
1ea836bb1b Remove howtos from build script 2016-09-21 16:22:49 +01:00
Benjamin Saunders
33d80408e0 Add a nix-shell environment suitable for building 
This enables easy execution of scripts/*.py by Nix users.

Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
 2016-08-30 21:26:35 -07:00
Richard van der Hoff
49cd65dd58 Add a license to the spec 
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
 2016-07-12 17:28:30 +01:00
Stas Rudakou
b6c41727c5 Add PyYAML to scripts/README.md 
PyYAML is a 3rd-party package used by `gendoc.py`.
 2016-06-11 14:10:21 +03:00
Richard van der Hoff
8b61dab1c6 gendoc.py: add --list_targets arg 
I want to be able to run all of the targets except one from matrix-doc, so make
a way to list the targets.
 2016-05-09 12:12:50 +01:00
Richard van der Hoff
f46a2a7f2b Include the basePath in the path in swagger output 
This fixes both SPEC-393, and ORG-52.
 2016-05-06 12:35:27 +01:00