Commit Graph

91 Commits (a2aa3cc00ed7c42ec29ee39f9097da25d6baef3c)

Author SHA1 Message Date
Kegsay e5559e4ea5 Merge pull request #106 from matrix-org/erikj/newline_gendoc_STOP_BEING_CRANKY
gendoc should just add newlines rather than complaining about the lack thereof
9 years ago
Erik Johnston 70704240dc gendoc should just add newlines rather than complaining about the lack thereof 9 years ago
Richard van der Hoff 013b6db895 Add a note on building the speculator
... because the wiki says you need to read the README on how to build it.
9 years ago
Richard van der Hoff 270e1d7aa8 Add richvdh to list of trusted pushers for spectulator
richvdh is awesome, he should have all the permissions.
9 years ago
Oddvar Lovaas 1cfe4f784f special css for spec/howto 9 years ago
Oddvar Lovaas ceebf34fca generate docs with new nav bar 9 years ago
Daniel Wagner-Hall 6922850643 Add missing return 9 years ago
Daniel Wagner-Hall b46f0e30b8 Checkout SHA of origin/master rather than merging 9 years ago
Daniel Wagner-Hall a0cf485919 speculator: Specify merge target 9 years ago
Kegan Dougal 7805ca87df If build.py throws, actually print stdout. Also run jenkins.sh in verbose mode. 9 years ago
Kegsay 8c092e3d11 Merge pull request #74 from matrix-org/module-presence
Presence module
9 years ago
Daniel Wagner-Hall 7df3d9090a Merge pull request #81 from matrix-org/daniel/speculatormerge
speculator: Merge after fetching, so that /spec/head works
9 years ago
Daniel Wagner-Hall 0e8f1b5475 Quote args 9 years ago
Daniel Wagner-Hall a69e03f577 speculator: Report listening port 9 years ago
Daniel Wagner-Hall 30232f20aa speculator: Merge after fetching, so that /spec/head works 9 years ago
Kegan Dougal cc6f256b24 Merge branch 'master' into module-presence
Conflicts:
	specification/modules/presence.rst
9 years ago
Kegsay f74cb4d54c Merge pull request #76 from matrix-org/speculator-speedup
Modify how speculator uses git repos
9 years ago
Kegan Dougal b6f0b67da6 Speed up continuserv
Ignore .git directory as that shouldn't affect spec generation. Also, when
we receive writes from the OS, wait a bit before re-generating the spec to
clump together multiple writes rather than re-generating one after another
and waiting for no more writes before serving the request.
9 years ago
Kegan Dougal ede43fbe9f Modify how speculator uses git repos
Modified so it has a "master" repo and local A/B repos which pull from the
"master". This saves an extra git clone operation per HTTP request.
9 years ago
Kegan Dougal 52f6496cf0 Merge branch 'master' into module-presence 9 years ago
Kegan Dougal a49d5f67f1 Delete rather than comment out the offending CSS 9 years ago
Kegan Dougal 4e1e82f995 Fix paragraph CSS and adjust where paragraphs are in the RST
The CSS for `nature.css` was such that it was preventing `p` tags from
having sufficient vertical whitespace. This meant that you couldn't insert
any kind of spacing between lengthy sections (they just appeared as new lines).

This PR fixes this so you can actually have some whitespace between paragraphs.
As a result of this change, some parts of the spec appeared to have too much
whitespace. These were often sections which shouldn't have begun a new
paragraph anyway (e.g. a single sentence being an entire paragraph, `TODO`
blocks resulting in new paragraphs). This PR fixes the most offending areas
where we shouldn't have been inserting new paragraphs.
9 years ago
Kegan Dougal 0a04672d76 Start converting the presence module. Add Rationale admonition. 9 years ago
Daniel Wagner-Hall 083a76096f Support viewing the spec at head 9 years ago
Daniel Wagner-Hall 2434dfaf1c Merge branch 'master' into speculator-htmldiff 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 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