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
ba4998a62b
Apparently tabs are A Thing
9 years ago
Kegan Dougal
427e4c8b1b
Log port being listened on
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
Kegan Dougal
9c3a333a6d
Apparently tabs are A Thing
9 years ago
Kegan Dougal
9b18fd252e
Log port being listened on
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
d251f791fb
speculator: Document /
9 years ago
Daniel Wagner-Hall
f9ef934625
Merge branch 'master' into speculator-list
...
Conflicts:
scripts/speculator/main.go
9 years ago
Kegsay
e4f4670260
Merge pull request #44 from matrix-org/speculator-errs
...
speculator: Don't ignore errors
9 years ago
Daniel Wagner-Hall
b6dab0009d
speculator: Don't ignore errors
9 years ago
Daniel Wagner-Hall
20f0284155
speculator: Unified diff for rst diff
9 years ago
Daniel Wagner-Hall
ba780a589a
speculator: Add list-pull-request functionality
9 years ago
Daniel Wagner-Hall
fef97802b7
Merge pull request #39 from matrix-org/speculator
...
speculator: Tool to preview spec pull requests
9 years ago
Daniel Wagner-Hall
bf318ffcd5
Add HTTP endpoints to README
9 years ago
Daniel Wagner-Hall
ca7dd49dc6
speculator: Add /healthz endpoint
9 years ago
Daniel Wagner-Hall
708f281270
Add comments about auth
9 years ago
Kegsay
c427c579cb
Merge pull request #37 from matrix-org/continuserv
...
continuserv: Server to live serve local updates to the spec
9 years ago
Daniel Wagner-Hall
c29aef362e
Error on failure of Watcher.Add
9 years ago
Daniel Wagner-Hall
6ac519d9dc
Log on file updates
9 years ago
Daniel Wagner-Hall
6e86cb34d2
continuserv: Adding README
9 years ago
Daniel Wagner-Hall
34091038f3
speculator: Tool to preview spec pull requests
...
Not the prettiest thing in the world, and horribly unperformant, but
useful :)
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
e30272733b
continuserv: Make port flag-specified
9 years ago
Daniel Wagner-Hall
c4acee3bcb
continuserv: Live serves updates to the spec
9 years ago
Daniel Wagner-Hall
0414ff4cc3
Output error if command fails
9 years ago
Kegan Dougal
e572cc662a
Restructure the first few sections.
...
Remove unecessary sections; put presnece/profile sections on the right level.
Move Living Standard warning to the top of the Introduction section.
10 years ago
Kegan Dougal
bb9537b824
Add a CHANGELOG. Modify table CSS.
...
Hook up templating system to read the CHANGELOG for version and changelog info.
Modified nature.css to make it clearer on table headings/sub-headings. Use the
full _matrix/client path on title links to make it clear it is for v1.
10 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