Ben Parsons
f1cc26dfd7
sort output by Created date per-table
7 years ago
Ben Parsons
b8f38b21a7
update introductory text
7 years ago
Ben Parsons
e87f1f2619
include PRs in tables
7 years ago
Ben Parsons
3b4e56c4e0
handle dd/mm/yyyy and yyyy-mm-dd dates in text
7 years ago
Ben Parsons
3b84de383c
cleanup and include all content
7 years ago
Ben Parsons
cbdd33a5f5
single authors and shepherds link correctly
7 years ago
Ben Parsons
73b7faddd4
handle multiple Google Docs
7 years ago
Ben Parsons
866b0b6348
I mostly play with ascii art
7 years ago
Ben Parsons
dc2b53318b
prettify ID column
7 years ago
Ben Parsons
a78f7b38e9
generator is now usable
7 years ago
Ben Parsons
c58dc59ffe
separate tables by label
7 years ago
Ben Parsons
1f7fbefd53
start using a table
7 years ago
Ben Parsons
e18aa30fd2
start generating new proposals page
7 years ago
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.
7 years ago
Richard van der Hoff
8e97ec8bad
make the speculator work for rick
7 years ago
Richard van der Hoff
9150ba0dce
Improve error output from failing to parse examples
7 years ago
Richard van der Hoff
a36bd1a6d2
Make build fail if gendoc fails
...
(cf https://github.com/matrix-org/matrix-doc/issues/1146 )
7 years ago
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.
7 years ago
Maxime Dor
1045bc721d
Document federation version endpoint
7 years ago
Richard van der Hoff
427e0bb83b
make jenkins and travis use a common script
7 years ago
Richard van der Hoff
202a265d85
Config for travis-ci
7 years ago
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.
7 years ago
Richard van der Hoff
a38d4fc68e
Move templating into scripts dir
...
There's no real need for this to be at the top level.
7 years ago
Richard van der Hoff
e7772af5c3
Supporting-docs now in matrix.org repo.
7 years ago
Richard van der Hoff
cc6b16b63c
Generate the swagger for export
...
We may as well generate the unstable version of the C-S swagger.
7 years ago
Richard van der Hoff
d6f892f894
continuserv, speculator: update dump-swagger call
...
dump-swagger now expects -o before its output path
7 years ago
Richard van der Hoff
56c3e5a627
README.rst: Add notes on how to build the spec
7 years ago
Richard van der Hoff
834a3d78a8
Add a pip requirements file for the scripts
7 years ago
Richard van der Hoff
986c9d99a0
Improve arg parsing in dump-swagger
7 years ago
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.
7 years ago
Richard van der Hoff
2454598926
Speculator: include API docs links for branches
7 years ago
Richard van der Hoff
13d3293378
Fix version-extraction regexp
...
Fixes https://github.com/matrix-org/matrix-doc/issues/982
7 years ago
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.
7 years ago
Richard van der Hoff
8a66b1a68b
Build the spec as part of the build
7 years ago
Richard van der Hoff
0af06291fe
Hardcode client major version r0
7 years ago
Richard van der Hoff
986e51cf35
Gendoc: allow overriding the dest dir
7 years ago
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.
7 years ago
Richard van der Hoff
934dd4754c
swagger-http-server: fix port param
...
it needs to be an int, not a list
8 years ago
Richard van der Hoff
2ec43a5948
Add continuserv index
...
Oops, forgot this when adding support for the API docs to continuserv in
bfb65d8
.
8 years ago
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.
8 years ago
Richard van der Hoff
bfb65d8ceb
Serve the API docs with continuserv
8 years ago
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.
8 years ago
Richard van der Hoff
459f4b953d
swagger-http-server: add a --port argument
8 years ago
Oddvar Lovaas
1ea836bb1b
Remove howtos from build script
8 years ago
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>
8 years ago
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).
8 years ago
Stas Rudakou
b6c41727c5
Add PyYAML to scripts/README.md
...
PyYAML is a 3rd-party package used by `gendoc.py`.
9 years ago
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.
9 years ago
Richard van der Hoff
f46a2a7f2b
Include the basePath in the path in swagger output
...
This fixes both SPEC-393, and ORG-52.
9 years ago
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)
9 years ago