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
|
#!/usr/bin/env python3
# Tracker commandline reference markdown generator.
#
# 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 argparse
import contextlib
import logging
import pathlib
import shutil
import subprocess
import sys
import tempfile
log = logging.getLogger('generate-cli-reference.py')
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('--template', required=True, metavar='TEMPLATE',
help="Template")
parser.add_argument('--output', required=True, metavar='OUTPUT',
help="Output file")
parser.add_argument('--debug', dest='debug', action='store_true',
help="Enable detailed logging to stderr")
parser.add_argument('--man-pages', nargs='+', required=True,
help="List of Asciidoc manual page source")
return parser
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 commandline reference page."""
includes = []
for html_file in sorted(html_files):
path = pathlib.Path(html_file)
filename = path.name;
title = filename.split('.')[0]
if title.startswith('tracker3-'):
title = 'tracker3 ' + title[9:]
includes.append("## %s\n\n%s\n\n" % (title, path.read_text()))
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()
template_file = pathlib.Path(args.template)
output_file = 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_file.exists():
output_file.unlink()
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 = workdir
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)
manpages.generate_toplevel_markdown(template_file, output_file, htmlfiles)
log.info("Commandline reference available at %s .", args.output)
try:
main()
except (RuntimeError, subprocess.CalledProcessError) as e:
sys.stderr.write(f"ERROR: {e}\n")
sys.exit(1)
|
