Travis Ralston
2753d24302
Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep
2018-08-30 12:17:09 -06:00
Richard van der Hoff
f649d04ae1
Merge pull request #1626 from matrix-org/rav/encoding
...
Set the encoding to UTF-8 on all file I/O
2018-08-30 18:11:38 +01:00
Richard van der Hoff
4e90b32348
Set the encoding to UTF-8 on all file I/O
...
Hopefully this will resolve issues with building the spec on systems where the
default encoding is somthing other than UTF-8.
2018-08-30 17:18:07 +01:00
Travis Ralston
b2092922e8
Don't define a variable for the appservice major version
2018-08-29 21:51:26 -06:00
Travis Ralston
a5c3924492
Merge remote matrix-org/master
2018-08-29 21:28:24 -06:00
Travis Ralston
c7a228bf7b
Don't make the major version a variable
...
We are likely to want to maintain v1 when we release a v2, so we'll avoid a variable for now.
2018-08-29 19:32:52 -06:00
Travis Ralston
e7a69a6a6d
Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep
2018-08-29 19:29:42 -06:00
Travis Ralston
b402608b41
Don't reference the major version for the push gateway specification
...
If we ever have a v2 endpoint for the push gateway, we'd likely spec it alongside the v1 stuff, updating applicable references elsewhere.
2018-08-28 14:40:14 -06:00
Travis Ralston
fa96d8629b
Prepare the appservice spec for an r0 release
...
This puts the scaffolding in place for an r0 release to happen, such as the changelog and version variables.
2018-08-27 18:04:08 -06:00
Travis Ralston
d370a2c6fd
Prepare the identity service and server-server APIs for r0
...
* Create the changelog scaffolding
* Set up the variables for versioning
2018-08-24 17:19:25 -06:00
Travis Ralston
ba51d5960e
r0.1.0 release of the Push Gateway specification
...
Because this is the first release, it has several moving parts to it:
* The version variables have been defined.
* The towncrier changelog has been prepared for future modifications.
* The templating has been updated to better support future versions of the specification.
* A release process document has been created.
2018-08-16 11:50:18 -06:00
Travis Ralston
ebc7db12fb
Remove extraneous list casting
2018-07-10 16:52:17 -06:00
Travis Ralston
9e0fafbcd4
Remove debugging line
2018-07-10 15:13:22 -06:00
Travis Ralston
550f95570b
Fix regex for some versions of python
2018-07-09 15:17:43 -06:00
Travis Ralston
c2f85788de
Add documentation about how to add to the changelog
2018-07-06 16:54:14 -06:00
Travis Ralston
f54d5a4039
Convert build scripts to python 3
2018-07-06 15:21:07 -06: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
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
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
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
Oddvar Lovaas
1ea836bb1b
Remove howtos from build script
2016-09-21 16:22:49 +01: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
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
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
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
97fd1fdd62
Embed client and server release numbers
...
Note that this also removes the changelog - I'm going to re-add the
changelog differently soon.
2015-12-01 17:08:02 +00:00
Daniel Wagner-Hall
e171acf01f
Split spec into page-per-section
2015-11-27 16:45:47 +00:00
Daniel Wagner-Hall
8586744771
Add anchors to spec
...
This is currently done by a script on the prod serving machine.
We might as well keep the matrix.org spec and dev spec as similar as
possible.
2015-11-19 16:41:58 -05:00
Mark Haines
df443c10ac
Move css into a css subdirectory.
...
Add css to put a bar next to blockquotes.
2015-10-23 11:58:06 +01:00
Erik Johnston
70704240dc
gendoc should just add newlines rather than complaining about the lack thereof
2015-10-14 16:29:18 +01:00
Kegan Dougal
7805ca87df
If build.py throws, actually print stdout. Also run jenkins.sh in verbose mode.
2015-10-07 10:34:29 +01:00
Kegan Dougal
6afdfc0771
Add more logging and make logging context clearer
...
This is now actually useful if you want to debug why your swagger YAML
isn't producing a table you think it should be.
2015-09-23 15:36:13 +01:00
Kegan Dougal
f1adad5fb3
Add more logging with file prefixes
...
This makes the handoff between gendoc and batesian clearer in the logs.
2015-09-23 15:10:55 +01:00
Kegan Dougal
064a2c9172
Use argparse and log functions for gendoc.py
...
gendoc.py has become more complex such that we actually want to pass things
to it like `--verbose`, `--nodelete`, `--target`, so use `argparse` to do this
like we have `build.py`. Pass through `-v` flags to `build.py`.
2015-09-23 14:59:57 +01:00
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
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
