Commit Graph

646 Commits (paragraphs)
 

Author SHA1 Message Date
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
Kegsay c96f02c2b0 Merge pull request #69 from matrix-org/erikj/login_token
m.login.token
9 years ago
Kegsay beafc74f81 Merge pull request #70 from matrix-org/spec-module-format
Modules format
9 years ago
Daniel Wagner-Hall eec021ee8c Merge pull request #72 from matrix-org/daniel/generateathead
Support viewing the spec at head
9 years ago
Daniel Wagner-Hall 083a76096f Support viewing the spec at head 9 years ago
Erik Johnston 6e6bc8a5a9 Mandate macaroon 9 years ago
Erik Johnston ce53a17180 Add txn_id rationale 9 years ago
Kegan Dougal 5abea1f2bc Minor tweaks 9 years ago
Kegan Dougal 70518ae655 Clarify template suffixes 9 years ago
Kegan Dougal 643468e914 Mention swagger. Clarify how event type template vars are formed. 9 years ago
Kegan Dougal c2fc1a2fb1 Add basic module template.
This has the core sections for events/server/client/security.
9 years ago
Erik Johnston 97154cc6b2 s/nonce/txn_id/ 9 years ago
Erik Johnston 4c9f524cab Neaten things up 9 years ago
Erik Johnston 317c2f20d3 Draft login token spec 9 years ago
Kegsay e5f805c0d5 Merge pull request #67 from matrix-org/unused-template-vars
Detect unused {{ vars }} and whine loudly.
9 years ago
Kegsay 4d407c2731 Merge pull request #66 from matrix-org/speculator-htmldiff
speculator: Add HTML diffing
9 years ago
Kegan Dougal 9c882ea5e4 Detect unused {{ vars }} and whine loudly. 9 years ago
Daniel Wagner-Hall 2434dfaf1c Merge branch 'master' into speculator-htmldiff 9 years ago
Daniel Wagner-Hall cd6f15f627 Remove obsolete comment 9 years ago
Daniel Wagner-Hall 0c1eb50ef4 Merge pull request #26 from matrix-org/macaroons
Spec macaroons and token refresh
9 years ago
Daniel Wagner-Hall f5d436bd80 Remove extraneous ) 9 years ago
Daniel Wagner-Hall 6c1491b3ba Respond to some review comments 9 years ago
Daniel Wagner-Hall 5c4398c181 Remove superfluous comma 9 years ago
Daniel Wagner-Hall fc87f4cdb0 Remove unused keys 9 years ago
Daniel Wagner-Hall 6c89e6ea67 Wrap refresh_token in `s 9 years ago
Kegsay 15308ab435 Merge pull request #62 from matrix-org/markjh/check_request_schema
Check the request example JSON matches the schema
9 years ago
Mark Haines f34722485f Check the request example JSON matches the schema 9 years ago
Kegsay ca9f30a7fd Merge pull request #61 from matrix-org/markjh/node_swagger_validator
Only validate a file if it ends with ".yaml".
9 years ago
Mark Haines 385b6c4759 Only validate a file if it ends with ".yaml".
Otherwise we try to validate vim .swp files.
9 years ago
Kegsay 0346568519 Merge pull request #60 from matrix-org/gendoc-logging
Gendoc logging
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
Kegsay 14e77b09ab Merge pull request #59 from matrix-org/spec-restructure-modules
Add spec build targets; restructure spec
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 29bae15790 Fix typo 9 years ago
Kegan Dougal 5115346297 Add instant_messaging module; modify batesian section rules
Previously, all `m.room.*` events were wodged into `{{room_events}}` which
isn't great when you want to pull specific ones out. Batesian had a 1:1
mapping of `render_foo()` to a section `{{foo}}`, and having to constantly
add functions for new types is a PITA. Batesian now supports returning a
`dict` instead of a section `string` where the keys are the `{{foo}}` and
the value is what will be inserted. Also add conflicting section key checks
to avoid multiple definitions of the same `{{foo}}`. Define dicts for
event schemata and swagger HTTP APIs.

Using this new feature, split out the instant messaging stuff from the events
section, and replace `{{room_events}}` with a list of specific events e.g.
`{{m_room_member_event}}`.
9 years ago
Kegan Dougal 5b134119bd Add presence module; fix relative title bug
If a relative title appeared after an HTTP API table, it
would insert the wrong level because it thought that part
of the table was a title.
9 years ago
Kegan Dougal b49cb57fe5 Move events sections to CS API 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 388aeefac0 Remove obsolete key 9 years ago
Kegan Dougal b0eb985523 Merge branch 'master' into spec-restructure-modules 9 years ago
Kegsay 895ffcfcde Merge pull request #56 from matrix-org/markjh/document_v1_rooms_api
Document the getters for the /rooms/{roomId} APIs
9 years ago
Kegan Dougal 056b5eba22 Partially handle representing top-level array responses
If an HTTP API returned a top-level array response, the templating system
would fail to create a table for it. This is now partially fixed by pulling
out the type of the elements (no recursion is done to populate nested tables)
9 years ago
Kegan Dougal 0c0ac3e814 Fix common event fields template to use subtitle char 9 years ago
Kegan Dougal e8cdfcbba2 Rename spec files to not have numbers everywhere; update targets.yaml 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
Mark Haines 98d91d0c2b Make the example room id more "random" so that people are less likely to think that it is supposed to be human readable 9 years ago