matrix-spec-proposals

Commit Graph

Author	SHA1	Message	Date
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
Kegan Dougal	96671ce833	Use the templating system to set {{git_version}}. Restructure sections code. Restructured the sections code to be slightly more encapsulated than before. This will be expanded to more clearly separate the templating system from the specific implementation of the spec templates.	10 years ago
Kegan Dougal	02c44a889e	Remove stuff from 20_events.rst and replace with {{room_events}}. Update gendoc to call build.py for template vars.	10 years ago
Matthew Hodgson	d40f6c1d7c	lots of fixes based on kegan's review of https://github.com/matrix-org/matrix-doc/pull/13	10 years ago
Matthew Hodgson	598e9b3113	big reshuffle: * try to make 00_basis slightly more accessible and less terse * move CS API before Events, as it's meaningless to dive into specific events if you haven't been introduced to how the CS API works * Try to improve the beginning of the CS API by merging back in some of kegan's original v1 content (which has subsequently been deleted somewhere along the line?) * document m.presence event consistently * move typing from drafts to spec * move push stuff from drafts to spec ...and lots of other stuff move push & typing from drafts into main spec.	10 years ago
Kegan Dougal	a6fa4e53fb	Update gendoc.py Copy howto to tmp/ so the $GIT_VERSION can be dropped in.	10 years ago
Kegan Dougal	505c804426	Update scripts to look in the right places. Update jsfiddles to be more obvious in the HOWTO.	10 years ago
Kegan Dougal	4b0e858529	Add $GIT_VERSION to the spec which is replaced by the gendoc script.	10 years ago
Kegan Dougal	df448df813	Redo gendoc script.	10 years ago

46 Commits (7c8651480a3393b00e0cb88c85a6e571817f132e)