Commit graph

33 commits

Author SHA1 Message Date
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`.
2015-09-23 14:59:57 +01:00
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.
2015-09-23 14:29:37 +01:00
Kegan Dougal
16693a644a Various review fixes 2015-09-22 16:59:49 +01:00
Kegan Dougal
b21859836d Print stdout of build.py in verbose mode 2015-09-22 16:11:16 +01:00
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.
2015-09-22 13:08:15 +01:00
Kegan Dougal
067363c629 Get the desired title levels right; print out the actual level used to stdout 2015-09-21 17:21:08 +01:00
Kegan Dougal
d5e0115e42 Merge branch 'master' into spec-restructure-modules 2015-09-21 16:55:24 +01:00
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 2015-09-21 16:54:30 +01:00
Kegan Dougal
8590cc84b5 Process and extract targets in gendoc.py 2015-09-21 15:33:28 +01:00
Mark Haines
6b5b8432b3 Turn on code highlighting for HTTP api responses and add a
code highlighting stylesheet for the specification.
2015-09-18 17:26:10 +01:00
Kegsay
5fbd534713 Merge pull request #51 from matrix-org/daniel/gendoc
Print errors to stderr
2015-09-18 15:50:56 +01:00
Kegan Dougal
cf8abdafd4 Fix PR comments 2015-09-18 15:42:49 +01:00
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
2015-09-18 11:43:53 +01:00
Kegan Dougal
06e46c1899 Fix on a better numbering format 2015-09-18 11:20:34 +01:00
Kegan Dougal
ef473b4161 Start enforcing title styles
This depends on the number of the file.
2015-09-18 11:05:48 +01:00
Daniel Wagner-Hall
08defafd98 Print errors to stderr
This means that continuserv will actually display them
2015-09-18 10:26:13 +01:00
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(!)
2015-09-18 10:03:58 +01:00
Daniel Wagner-Hall
21411309e0 Fix chdir path 2015-09-15 16:27:10 +01:00
Mark Haines
c3eab1cc3c Set the current working directory in gendoc.py to the script directory as that is where it expects to be run 2015-09-15 11:41:40 +01:00
Daniel Wagner-Hall
cdc06a8bf1 Document --nodelete 2015-09-10 13:53:38 +01:00
Daniel Wagner-Hall
a74fb54053 Correct comment 2015-09-10 13:44:41 +01:00
Daniel Wagner-Hall
ad595aea45 Optionally don't delete intermediate rst files
Useful for debugging
Hackily hackily implemented :)
2015-09-10 13:21:08 +01:00
Daniel Wagner-Hall
0414ff4cc3 Output error if command fails 2015-09-07 16:27:18 +01:00
Kegan Dougal
f9710a6e17 Add help blurb to gendoc.py 2015-05-28 14:16:57 +01:00
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.
2015-05-26 16:20:15 +01:00
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.
2015-05-26 14:33:32 +01:00
Kegan Dougal
02c44a889e Remove stuff from 20_events.rst and replace with {{room_events}}. Update gendoc to call build.py for template vars. 2015-05-20 15:40:06 +01:00
Matthew Hodgson
d40f6c1d7c lots of fixes based on kegan's review of https://github.com/matrix-org/matrix-doc/pull/13 2015-03-19 14:20:58 +01:00
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.
2015-03-16 00:14:03 -04:00
Kegan Dougal
a6fa4e53fb Update gendoc.py
Copy howto to tmp/ so the $GIT_VERSION can be dropped in.
2015-02-20 11:25:05 +00:00
Kegan Dougal
505c804426 Update scripts to look in the right places. Update jsfiddles to be more obvious in the HOWTO. 2015-02-20 10:49:36 +00:00
Kegan Dougal
4b0e858529 Add $GIT_VERSION to the spec which is replaced by the gendoc script. 2015-02-19 16:32:45 +00:00
Kegan Dougal
df448df813 Redo gendoc script. 2015-02-19 16:00:21 +00:00