OLD | NEW |
---|---|
(Empty) | |
1 #!/usr/bin/env python | |
2 | |
Paweł Hajdan Jr.
2015/02/24 13:23:47
nit: Remove this empty line.
Deprecated (see juliatuttle)
2015/02/24 14:56:22
Done.
| |
3 # Copyright 2014 The Chromium Authors. All rights reserved. | |
Paweł Hajdan Jr.
2015/02/24 13:23:46
nit: 2015
Deprecated (see juliatuttle)
2015/02/24 14:56:22
Done.
| |
4 # Use of this source code is governed by a BSD-style license that can be | |
5 # found in the LICENSE file. | |
6 | |
7 | |
8 """Reads, parses, and (optionally) writes as HTML the contents of Markdown | |
9 files passed as arguments. Intended for rendering network stack documentation | |
10 stored as Markdown in the source tree to a human-readable format.""" | |
11 | |
12 | |
13 import argparse | |
14 import os.path | |
15 import sys | |
16 | |
17 | |
18 def nth_parent_directory(path, n): | |
19 for i in range(n): | |
20 path = os.path.dirname(path) | |
21 return path | |
22 | |
23 | |
24 # Go up the directory tree from this script and add src/third_party to sys.path | |
25 # so "import markdown" can find it in src/third_party/markdown. | |
26 SCRIPT_PATH = os.path.abspath(__file__) | |
27 SRC_PATH = nth_parent_directory(SCRIPT_PATH, 4) | |
28 THIRD_PARTY_PATH = os.path.join(SRC_PATH, 'third_party') | |
29 sys.path.insert(0, THIRD_PARTY_PATH) | |
30 import markdown | |
31 | |
32 | |
33 def ReadFile(filename): | |
34 with open(filename, 'r') as file: | |
35 return file.read() | |
36 | |
37 | |
38 def WriteFile(filename, contents): | |
39 dir = os.path.dirname(filename) | |
40 if not os.path.isdir(dir): | |
41 os.mkdir(dir) | |
42 with open(filename, 'w') as file: | |
43 file.write(contents) | |
44 | |
45 | |
46 TEMPLATE = """ | |
47 <html> | |
48 <head> | |
49 <title>{title}</title> | |
50 </head> | |
51 <body> | |
52 {body} | |
53 </body> | |
54 </html>""" | |
55 | |
56 | |
57 def FormatPage(markdown_html, title): | |
58 # TODO(ttuttle): Add navigation? | |
59 return TEMPLATE.format(title=title, body=markdown_html) | |
60 | |
61 | |
62 def ProcessDocs(input_filenames, input_pathname, output_pathname): | |
63 """Processes a list of Markdown documentation files. | |
64 | |
65 If input_pathname and output_pathname are specified, outputs HTML files | |
66 into the corresponding subdirectories of output_pathname. If one or both is | |
67 not specified, simply ensures the files exist and contain valid Markdown. | |
68 | |
69 Args: | |
70 input_filenames: A list of filenames (absolute, or relative to $PWD) of | |
71 Markdown files to parse and possibly render. | |
72 input_pathname: The base directory from which relative paths to input | |
73 filenames are formed. | |
74 output_pathname: The output directory into which rendered Markdown files | |
75 go, using that relative path. | |
76 | |
77 Returns: | |
78 nothing | |
79 | |
80 Raises: | |
81 IOError: if any of the file operations fail (e.g. input_filenames | |
82 contains a non-existent file). | |
83 """ | |
84 | |
85 outputting = (input_pathname is not None) and (output_pathname is not None) | |
86 | |
87 markdown_parser = markdown.Markdown() | |
88 | |
89 for input_filename in input_filenames: | |
90 markdown_text = ReadFile(input_filename) | |
91 markdown_html = markdown_parser.reset().convert(markdown_text) | |
92 if not outputting: | |
93 continue | |
94 | |
95 full_html = FormatPage(markdown_html, title=input_filename) | |
96 rel_filename = os.path.relpath(input_filename, start=input_pathname) | |
97 output_filename = os.path.join(output_pathname, rel_filename) + '.html' | |
98 WriteFile(output_filename, full_html) | |
99 | |
100 | |
101 def main(): | |
102 parser = argparse.ArgumentParser( | |
103 description='Parse and render Markdown documentation') | |
104 parser.add_argument('--input_path', default=None, | |
105 help="Input path for Markdown; required only if output_path set") | |
106 parser.add_argument('--output_path', default=None, | |
107 help="Output path for rendered HTML; if unspecified, won't output") | |
108 parser.add_argument('filenames', nargs=argparse.REMAINDER) | |
109 args = parser.parse_args() | |
110 | |
111 ProcessDocs(args.filenames, args.input_path, args.output_path) | |
112 | |
113 return 0 | |
114 | |
115 | |
116 if __name__ == '__main__': | |
117 sys.exit(main()) | |
OLD | NEW |