1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
#!/usr/bin/python
"""
Generate the Botan website
(C) 2017 Jack Lloyd
"""
import optparse # pylint: disable=deprecated-module
import subprocess
import sys
import errno
import shutil
import tempfile
import os
def run_and_check(cmd_line, cwd=None):
print("Executing %s ..." % (' '.join(cmd_line)))
proc = subprocess.Popen(cmd_line,
cwd=cwd,
close_fds=True,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
(stdout, stderr) = proc.communicate()
if proc.returncode != 0:
print("Error running %s" % (' '.join(cmd_line)))
print(stdout)
print(stderr)
sys.exit(1)
def rmtree_ignore_missing(path):
try:
shutil.rmtree(path)
except OSError:
# check errno?
pass
def configure_build(botan_dir, build_dir):
run_and_check([os.path.join(botan_dir, 'configure.py'),
'--with-doxygen', '--with-sphinx',
'--with-build-dir=%s' % (build_dir)])
def run_doxygen(tmp_dir, output_dir):
run_and_check(['doxygen', os.path.join(tmp_dir, 'build/botan.doxy')])
shutil.move(os.path.join(tmp_dir, 'build/docs/doxygen'), output_dir)
def run_sphinx(botan_dir, tmp_dir, output_dir):
sphinx_config = os.path.join(botan_dir, 'src/configs/sphinx')
sphinx_dir = os.path.join(tmp_dir, 'sphinx')
os.mkdir(sphinx_dir)
shutil.copyfile(os.path.join(botan_dir, 'readme.rst'),
os.path.join(sphinx_dir, 'index.rst'))
for f in ['news.rst', os.path.join('doc', 'security.rst')]:
shutil.copy(os.path.join(botan_dir, f), sphinx_dir)
toc = """.. toctree::
index
news
security
User Guide <https://botan.randombit.net/handbook>
API Reference <https://botan.randombit.net/doxygen>
"""
contents_rst = open(os.path.join(sphinx_dir, 'contents.rst'), 'w')
contents_rst.write(toc)
contents_rst.close()
sphinx_invoke = ['sphinx-build', '-t', 'website', '-c', sphinx_config, '-b', 'html']
handbook_dir = os.path.join(botan_dir, 'doc')
run_and_check(sphinx_invoke + [sphinx_dir, output_dir])
run_and_check(sphinx_invoke + [handbook_dir, os.path.join(output_dir, 'handbook')])
rmtree_ignore_missing(os.path.join(output_dir, '.doctrees'))
rmtree_ignore_missing(os.path.join(output_dir, 'handbook', '.doctrees'))
os.remove(os.path.join(output_dir, '.buildinfo'))
os.remove(os.path.join(output_dir, 'handbook', '.buildinfo'))
# share _static subdirs
shutil.rmtree(os.path.join(output_dir, 'handbook', '_static'))
os.symlink('../_static', os.path.join(output_dir, 'handbook', '_static'))
# Build PDF
latex_output = os.path.join(tmp_dir, 'latex')
run_and_check(['sphinx-build', '-c', sphinx_config, '-b', 'latex', handbook_dir, latex_output])
# Have to run twice because TeX
run_and_check(['pdflatex', 'botan.tex'], cwd=latex_output)
run_and_check(['pdflatex', 'botan.tex'], cwd=latex_output)
shutil.copy(os.path.join(latex_output, 'botan.pdf'),
os.path.join(output_dir, 'handbook'))
def main(args):
parser = optparse.OptionParser()
parser.add_option('-o', '--output-dir', default=None,
help="Where to write output")
(options, args) = parser.parse_args(args)
output_dir = options.output_dir
tmp_dir = tempfile.mkdtemp(prefix='botan_website_')
# assumes we live in src/scripts
botan_dir = os.path.normpath(os.path.join(os.path.dirname(__file__),
"..", ".."))
if os.access(os.path.join(botan_dir, 'configure.py'), os.X_OK) is False:
print("Can't find configure.py in %s", botan_dir)
return 1
if output_dir is None:
cwd = os.getcwd()
if os.path.basename(cwd) == 'botan-website':
output_dir = '.'
else:
output_dir = os.path.join(cwd, 'botan-website')
try:
os.mkdir(output_dir)
except OSError as e:
if e.errno == errno.EEXIST:
pass
else:
raise e
for subdir in ['_static', '_sources', 'doxygen', 'handbook']:
try:
shutil.rmtree(os.path.join(output_dir, subdir))
except OSError as e:
if e.errno == errno.ENOENT:
pass
else:
print("Error removing dir", e)
return 1
configure_build(botan_dir, tmp_dir)
run_doxygen(tmp_dir, output_dir)
run_sphinx(botan_dir, tmp_dir, output_dir)
for f in ['doc/pgpkey.txt', 'license.txt']:
shutil.copy(os.path.join(botan_dir, f), output_dir)
favicon = open(os.path.join(output_dir, 'favicon.ico'), 'w')
# Create an empty favicon.ico file so it gets cached by browsers
favicon.close()
shutil.rmtree(tmp_dir)
return 0
if __name__ == '__main__':
sys.exit(main(sys.argv))
|
