Commit Graph

58 Commits (78b8133142d943c30efeea234f184ba7936fa7fa)

Author SHA1 Message Date
Travis Ralston ebc7db12fb Remove extraneous list casting 6 years ago
Travis Ralston 9e0fafbcd4 Remove debugging line 6 years ago
Travis Ralston 550f95570b Fix regex for some versions of python 6 years ago
Travis Ralston c2f85788de Add documentation about how to add to the changelog 6 years ago
Travis Ralston f54d5a4039 Convert build scripts to python 3 6 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
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 13d3293378 Fix version-extraction regexp
Fixes https://github.com/matrix-org/matrix-doc/issues/982
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
Oddvar Lovaas 1ea836bb1b Remove howtos from build script 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
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 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.
9 years ago
Richard van der Hoff a8eed29e9f gendoc: Allow multiple targets 9 years ago
Richard van der Hoff 1f6c4d5bb2 Speed up gendoc.py by only running build.py once 9 years ago
Daniel Wagner-Hall aaeaa1dd98 Detect major version in presence of patch release 9 years ago
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.
9 years ago
Daniel Wagner-Hall e171acf01f Split spec into page-per-section 9 years ago
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.
9 years ago
Mark Haines df443c10ac Move css into a css subdirectory.
Add css to put a bar next to blockquotes.
9 years ago
Erik Johnston 70704240dc gendoc should just add newlines rather than complaining about the lack thereof 9 years ago
Kegan Dougal 7805ca87df If build.py throws, actually print stdout. Also run jenkins.sh in verbose mode. 9 years ago
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.
9 years ago
Kegan Dougal f1adad5fb3 Add more logging with file prefixes
This makes the handoff between gendoc and batesian clearer in the logs.
9 years ago
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`.
9 years ago
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.
9 years ago
Kegan Dougal 16693a644a Various review fixes 9 years ago
Kegan Dougal b21859836d Print stdout of build.py in verbose mode 9 years ago
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.
9 years ago
Kegan Dougal 067363c629 Get the desired title levels right; print out the actual level used to stdout 9 years ago
Kegan Dougal d5e0115e42 Merge branch 'master' into spec-restructure-modules 9 years ago
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 9 years ago
Kegan Dougal 8590cc84b5 Process and extract targets in gendoc.py 9 years ago
Mark Haines 6b5b8432b3 Turn on code highlighting for HTTP api responses and add a
code highlighting stylesheet for the specification.
9 years ago
Kegsay 5fbd534713 Merge pull request #51 from matrix-org/daniel/gendoc
Print errors to stderr
9 years ago
Kegan Dougal cf8abdafd4 Fix PR comments 9 years ago
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
9 years ago
Kegan Dougal 06e46c1899 Fix on a better numbering format 9 years ago
Kegan Dougal ef473b4161 Start enforcing title styles
This depends on the number of the file.
9 years ago
Daniel Wagner-Hall 08defafd98 Print errors to stderr
This means that continuserv will actually display them
9 years ago
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(!)
9 years ago
Daniel Wagner-Hall 21411309e0 Fix chdir path 9 years ago
Mark Haines c3eab1cc3c Set the current working directory in gendoc.py to the script directory as that is where it expects to be run 9 years ago
Daniel Wagner-Hall cdc06a8bf1 Document --nodelete 9 years ago
Daniel Wagner-Hall a74fb54053 Correct comment 9 years ago
Daniel Wagner-Hall ad595aea45 Optionally don't delete intermediate rst files
Useful for debugging
Hackily hackily implemented :)
9 years ago
Daniel Wagner-Hall 0414ff4cc3 Output error if command fails 9 years ago
Kegan Dougal f9710a6e17 Add help blurb to gendoc.py 10 years ago
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.
10 years ago