wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update gendoc.py

Browse source 
Copy howto to tmp/ so the $GIT_VERSION can be dropped in.
This commit is contained in:
Kegan Dougal 2015-02-20 11:25:05 +00:00
parent 505c804426
commit a6fa4e53fb
2 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
scripts/gendoc.py
View file

@ -62,7 +62,7 @@ def get_git_ver_string():
return "Unknown rev" return "Unknown rev"
def glob_spec(out_file_name): def glob_spec_to(out_file_name):
with open(out_file_name, "wb") as outfile: with open(out_file_name, "wb") as outfile:
for f in sorted(glob.glob("../specification/*.rst")): for f in sorted(glob.glob("../specification/*.rst")):
with open(f, "rb") as infile: with open(f, "rb") as infile:
@ -105,10 +105,12 @@ def cleanup_env():
def main(): def main():
prepare_env() prepare_env()
glob_spec("tmp/full_spec.rst") glob_spec_to("tmp/full_spec.rst")
shutil.copy("../supporting-docs/howtos/client-server.rst", "tmp/howto.rst")
set_git_version("tmp/full_spec.rst") set_git_version("tmp/full_spec.rst")
set_git_version("tmp/howto.rst")
rst2html("tmp/full_spec.rst", "gen/specification.html") rst2html("tmp/full_spec.rst", "gen/specification.html")
rst2html("../supporting-docs/howtos/client-server.rst", "gen/howtos.html") rst2html("tmp/howto.rst", "gen/howtos.html")
cleanup_env() cleanup_env()
if __name__ == '__main__': if __name__ == '__main__':

4
supporting-docs/howtos/client-server.rst
View file

@ -4,10 +4,12 @@
would be better if /register used the same technique as /login? /register should would be better if /register used the same technique as /login? /register should
be "user" not "user_id". be "user" not "user_id".
How to use the client-server API How to use the client-server API
================================ ================================
.. NOTE::
The git version of this document is ``$GIT_VERSION``
This guide focuses on how the client-server APIs *provided by the reference This guide focuses on how the client-server APIs *provided by the reference
home server* can be used. Since this is specific to a home server home server* can be used. Since this is specific to a home server
implementation, there may be variations in relation to registering/logging in implementation, there may be variations in relation to registering/logging in