This repository has been archived by the owner on Aug 21, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 63
/
gen_docs.py
executable file
·68 lines (51 loc) · 1.97 KB
/
gen_docs.py
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
#!/usr/bin/python
# Copyright 2016 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Generates HTML documentation for the project."""
import argparse
import os
import subprocess
import sys
ROOT_DIR = os.path.dirname(os.path.realpath(__file__))
BUILD_PATH = os.path.join(ROOT_DIR, 'third_party', 'doxygen', 'build')
BIN_PATH = os.path.join(BUILD_PATH, 'bin', 'doxygen')
sys.path.append(os.path.join(ROOT_DIR, 'shaka', 'tools'))
import utils
def CompileDoxygen():
"""Compiles the doxygen program, if needed."""
if os.path.exists(BIN_PATH):
return 0
if not os.path.exists(BUILD_PATH):
os.mkdir(BUILD_PATH)
if subprocess.call(['cmake', '../src'], cwd=BUILD_PATH) != 0:
return 1
return subprocess.call(['make', '-j4'], cwd=BUILD_PATH)
def GenDocs():
"""Generates the library documentation."""
utils.LoadSubmodule('third_party/doxygen/src')
if CompileDoxygen() != 0:
return 1
return subprocess.call([BIN_PATH], cwd=ROOT_DIR)
def GenerateDoxyfile(extra_path):
"""Generates the Doxyfile configuration file."""
with open(os.path.join(ROOT_DIR, 'Doxyfile.in'), 'r') as in_file:
with open(os.path.join(ROOT_DIR, 'Doxyfile'), 'w') as out_file:
out_file.write(in_file.read().replace('{{EXTRA_PATH}}', extra_path))
def main(args):
parser = argparse.ArgumentParser(description=__doc__)
parser.parse_args(args)
GenerateDoxyfile(os.path.join(os.getcwd(), 'gen', 'shaka'))
return GenDocs()
if __name__ == '__main__':
sys.exit(main(sys.argv[1:]))