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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
#!/usr/bin/env python3
# Tracker website build script.
#
# Copyright 2020, Sam Thursfield <sam@afuera.me.uk>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
import bs4
import argparse
import contextlib
import logging
import pathlib
import shutil
import subprocess
import sys
import tempfile
log = logging.getLogger('build.py')
website_root = pathlib.Path(__file__).parent
docs_root = website_root.parent
source_root = docs_root.parent
asciidoc = shutil.which('asciidoc')
mkdocs = shutil.which('mkdocs')
xmlto = shutil.which('xmlto')
def argument_parser():
parser = argparse.ArgumentParser(
description="Tracker website build script")
parser.add_argument('--output', required=True, metavar='OUTPUT',
help="Output directory")
parser.add_argument('--debug', dest='debug', action='store_true',
help="Enable detailed logging to stderr")
parser.add_argument('--api-docs', required=True, metavar='PATH',
help="Path that contains API documentation. Usually "
"$prefix/share/gtk-doc/html/")
parser.add_argument('--tracker-commit', required=True, metavar='COMMIT',
help="Commit ID of tracker.git repo used to build")
parser.add_argument('--man-pages', nargs='+', required=True,
help="List of Asciidoc manual page source")
return parser
def apidocs_header(tracker_commit):
return f"""<!-- Inserted by {__file__} -->
<div class="warning">
<p>This is a documentation preview for the next version of Tracker,
generated from <a href="https://gitlab.gnome.org/GNOME/tracker/commit/{tracker_commit}/">tracker.git commit {tracker_commit[:7]}</a>.</p>
<p>See the <a href="https://gnome.pages.gitlab.gnome.org/tracker/docs/developer/">Tracker website</a> for more documentation.</p>
</div>"""
def add_apidocs_header(text, filename):
"""Add a header to the documentation preview files."""
# We insert the header before any of these
markers = [
'<div class="book">',
'<div class="chapter">',
'<div class="index">',
'<div class="glossary">',
'<div class="part">',
'<div class="refentry">',
'<div class="section">',
]
wrote_marker = False
with open(filename, encoding='utf8') as f_in:
with tempfile.NamedTemporaryFile(delete=False, mode='w', encoding='utf8') as f_out:
for line in f_in:
for marker in markers:
if not wrote_marker and line.find(marker) != -1:
f_out.write(text)
wrote_marker = True
f_out.write(line)
shutil.move(f_out.name, filename)
class Manpages():
def run(self, command):
command = [str(c) for c in command]
log.debug("Running: %s", ' '.join(command))
subprocess.run(command, check=True)
def generate_manpage_xml(self, in_path, out_path):
"""Generate a docbook XML file for an Asciidoc manpage source file."""
self.run([asciidoc, '--backend', 'docbook', '--doctype', 'manpage',
'--out-file', out_path, in_path])
def generate_manpage_html(self, in_path, out_path):
"""Generate a HTML page from a docbook XML file"""
self.run([xmlto, 'xhtml-nochunks', '-o', out_path, in_path])
def generate_toplevel_markdown(self, in_path, out_path, html_files):
"""Generate the master commandline.md page."""
includes = []
for path in sorted(html_files):
parser = bs4.BeautifulSoup(path.read_text(), 'html.parser')
title = parser.title.text
if title and title.startswith('tracker-'):
title = 'tracker ' + title[8:]
body = parser.body.contents[0]
includes.append("## %s\n\n%s\n---\n" % (title, body))
text = in_path.read_text()
text = text.format(
includes='\n'.join(includes)
)
out_path.write_text(text)
@contextlib.contextmanager
def tmpdir():
path = pathlib.Path(tempfile.mkdtemp())
log.debug("Created temporary directory %s", path)
try:
yield path
finally:
log.debug("Removed temporary directory %s", path)
shutil.rmtree(path)
def main():
args = argument_parser().parse_args()
output_path = pathlib.Path(args.output)
if args.debug:
logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)
else:
logging.basicConfig(stream=sys.stderr, level=logging.INFO)
if output_path.exists():
raise RuntimeError(f"Output path '{output_path}' already exists.")
if asciidoc is None:
raise RuntimeError("The 'asciidoc' tool is required.")
if xmlto is None:
raise RuntimeError("The 'xmlto' tool is required.")
log.info("Generating online man pages")
with tmpdir() as workdir:
manpages = Manpages()
htmldir = website_root.joinpath('docs')
htmlfiles = []
for man_page in args.man_pages:
asciidocpath = pathlib.Path(man_page)
xmlpath = workdir.joinpath(asciidocpath.stem + '.xml')
manpages.generate_manpage_xml(asciidocpath, xmlpath)
manpages.generate_manpage_html(xmlpath, htmldir)
htmlpath = htmldir.joinpath(xmlpath.with_suffix('.html').name)
htmlfiles.append(htmlpath)
template_in = website_root.joinpath('docs/commandline.md.in')
template_out = website_root.joinpath('docs/commandline.md')
manpages.generate_toplevel_markdown(template_in, template_out, htmlfiles)
#shutil.copy('/usr/share/asciidoc/stylesheets/docbook-xsl.css', manpage_output_path)
log.info("Building website")
mkdocs_config = docs_root.joinpath('mkdocs.yml')
subprocess.run([mkdocs, 'build', '--config-file', mkdocs_config,
'--site-dir', output_path.absolute()],
check=True)
apidocs_src = pathlib.Path(args.api_docs)
log.info("Copying API reference documentation from %s", apidocs_src)
apidocs_dest = output_path.joinpath('docs/developer/')
shutil.rmtree(apidocs_dest)
src = apidocs_src
dest = apidocs_dest
if not src.exists():
raise RuntimeError("Expected path {} doesn't exist.".format(src))
log.info(" - Copying %s to %s (%i files)", src, dest, len(list(src.iterdir())))
shutil.copytree(src, dest)
log.info("Adding preview header to API reference documentation")
text = apidocs_header(args.tracker_commit)
for filename in apidocs_dest.rglob('*.html'):
add_apidocs_header(text, filename)
log.info("Documentation available in %s/ directory.", args.output)
try:
main()
except (RuntimeError, subprocess.CalledProcessError) as e:
sys.stderr.write(f"ERROR: {e}\n")
sys.exit(1)
|
