You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
2.6 KiB
Python
92 lines
2.6 KiB
Python
#! /usr/bin/env python
|
|
|
|
from docutils.core import publish_file
|
|
import fileinput
|
|
import glob
|
|
import os
|
|
import shutil
|
|
import subprocess
|
|
import sys
|
|
|
|
stylesheets = {
|
|
"stylesheet_path": ["basic.css", "nature.css"]
|
|
}
|
|
|
|
def glob_spec_to(out_file_name):
|
|
with open(out_file_name, "wb") as outfile:
|
|
for f in sorted(glob.glob("../specification/*.rst")):
|
|
with open(f, "rb") as infile:
|
|
outfile.write(infile.read())
|
|
|
|
|
|
def rst2html(i, o):
|
|
with open(i, "r") as in_file:
|
|
with open(o, "w") as out_file:
|
|
publish_file(
|
|
source=in_file,
|
|
destination=out_file,
|
|
reader_name="standalone",
|
|
parser_name="restructuredtext",
|
|
writer_name="html",
|
|
settings_overrides=stylesheets
|
|
)
|
|
|
|
def run_through_template(input):
|
|
tmpfile = './tmp/output'
|
|
try:
|
|
with open(tmpfile, 'w') as out:
|
|
subprocess.check_output(
|
|
[
|
|
'python', 'build.py',
|
|
"-i", "matrix_templates",
|
|
"-o", "../scripts/tmp",
|
|
"../scripts/"+input
|
|
],
|
|
stderr=out,
|
|
cwd="../templating",
|
|
)
|
|
except subprocess.CalledProcessError as e:
|
|
with open(tmpfile, 'r') as f:
|
|
print f.read()
|
|
raise
|
|
|
|
def prepare_env():
|
|
try:
|
|
os.makedirs("./gen")
|
|
except OSError:
|
|
pass
|
|
try:
|
|
os.makedirs("./tmp")
|
|
except OSError:
|
|
pass
|
|
|
|
def cleanup_env():
|
|
shutil.rmtree("./tmp")
|
|
|
|
def main():
|
|
prepare_env()
|
|
glob_spec_to("tmp/full_spec.rst")
|
|
run_through_template("tmp/full_spec.rst")
|
|
shutil.copy("../supporting-docs/howtos/client-server.rst", "tmp/howto.rst")
|
|
run_through_template("tmp/howto.rst")
|
|
rst2html("tmp/full_spec.rst", "gen/specification.html")
|
|
rst2html("tmp/howto.rst", "gen/howtos.html")
|
|
if "--nodelete" not in sys.argv:
|
|
cleanup_env()
|
|
|
|
if __name__ == '__main__':
|
|
if len(sys.argv) > 1 and sys.argv[1:] != ["--nodelete"]:
|
|
# we accept almost no args, so they don't know what they're doing!
|
|
print "gendoc.py - Generate the Matrix specification as HTML."
|
|
print "Usage:"
|
|
print " python gendoc.py [--nodelete]"
|
|
print ""
|
|
print "The specification can then be found in the gen/ folder."
|
|
print ("If --nodelete was specified, intermediate files will be "
|
|
"present in the tmp/ folder.")
|
|
print ""
|
|
print "Requirements:"
|
|
print " - This script requires Jinja2 and rst2html (docutils)."
|
|
sys.exit(0)
|
|
main()
|