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

186 commits

Author SHA1 Message Date
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
Richard van der Hoff
8aa0f64665 Update the speculator to understand spec subdirs 
Fix the speculator so that it doesn't blow up when it finds subdirs in the gen
directory.

(It doesn't handle the html diff very well in the case that the subdirs don't
match, but it's hard to do much about that)
 2016-05-05 18:46:29 +01:00
Richard van der Hoff
01f8173c84 Put each bit of spec in its own directory 
I want to change the URLs for the spec sections on the website from
<version>/<section>.html to <section>/<version>.html, to better reflect how we
do the versioning.

This puts each bit of spec in its own directory, updates the index to point to
the right place, and fixes continuserv to deal with directories as well as
files.

This will probably require fixes to the speculator too, but I'll have to come
back to that.
 2016-05-05 18:26:17 +01:00
Richard van der Hoff
a8eed29e9f gendoc: Allow multiple targets 2016-05-05 16:49:10 +01:00
Richard van der Hoff
7138205f31 Update README.md 
escape angle-bracket to stop it getting lost in markdown
 2016-05-04 01:08:50 +01:00
Richard van der Hoff
0546f0917d Replace hacky shell to do matrix styling with hacky perl 
Since the shell just wrapped three invocations of perl, we might as well do
it all in perl.
 2016-05-04 00:01:54 +01:00
Richard van der Hoff
23c4ffbc1b Add securityDefintions to generated swagger JSON 
Also factor out to a common file
 2016-05-03 13:57:16 +01:00
Richard van der Hoff
60f36bf868 Script to serve the generated swagger JSON 
We need custom CORS headers to serve the swagger JSON, so add a script to do it
 2016-05-03 12:04:44 +01:00
Richard van der Hoff
c39d797cce Dump-swagger: take output file name rather than output dir 
Make the argument to dump-swagger.py be the name of the output file rather than
the output dir, and give it a sensible default.

Also, use the absolute path to the output file, so that the output path is
relative to the user's cwd rather than the templating dir.
 2016-05-03 12:03:21 +01:00
Richard van der Hoff
d6c1d1343b Continuserv: Reduce number of watches 
rather than trying to watch half the filesystem, be a bit more conservative in
what we put watches on. This means that we don't end up dying with "No space on
device" (thanks for that, Linux.)
 2016-04-11 23:21:21 +01:00
Daniel Wagner-Hall
072d285153 speculator: Allow access token to be specified 2016-02-15 14:48:26 +00:00
Richard van der Hoff
1f6c4d5bb2 Speed up gendoc.py by only running build.py once 2016-01-08 00:40:03 +00:00
Daniel Wagner-Hall
aaeaa1dd98 Detect major version in presence of patch release 2015-12-09 15:56:58 +00:00
Daniel Wagner-Hall
ad7874a730 Use site-relative stylesheet 2015-12-09 14:35:25 +00:00
Daniel Wagner-Hall
60127de1e3 Take list of files to edit as args 2015-12-09 13:50:15 +00:00
Daniel Wagner-Hall
a9b4f6fef0 Add missing _ to paths 2015-12-08 15:39:32 +00:00
Daniel Wagner-Hall
db5cad4711 Remove accidentally committed change 2015-12-07 15:16:06 +00:00
Daniel Wagner-Hall
99b8a066c8 Make dump-swagger work from all directories 2015-12-07 14:40:42 +00:00