Debian Codegraph @

manual/build.py

raw
1 #!/usr/bin/env python
2
3
4 __license__ = 'GPL v3'
5 __copyright__ = '2014, Kovid Goyal <kovid at kovidgoyal.net>'
6
7 import os
8 import shutil
9 import subprocess
10 import sys
11 import tempfile
12 from functools import partial
13
14 j, d, a = os.path.join, os.path.dirname, os.path.abspath
15 BASE = d(a(__file__))
16 SPHINX_BUILD = ['sphinx-build']
17
18 sys.path.insert(0, d(BASE))
19 from setup import __appname__, __version__
20
21 sys.path.remove(d(BASE))
22 from calibre.ebooks.oeb.polish.container import epub_to_azw3
23
24
25 def sphinx_build(language, base, builder='html', bdir='html', t=None, quiet=True, very_quiet=False):
26 destdir = j(base, bdir)
27 if not os.path.exists(destdir):
28 os.makedirs(destdir)
29 ans = SPHINX_BUILD + ['-D', ('language=' + language), '-b', builder]
30 if quiet:
31 ans.append('-q')
32 if very_quiet:
33 ans.append('-Q')
34 if builder == 'html':
35 ans += ['-w', j(destdir, 'sphinx-build-warnings.txt')]
36 if t:
37 ans += ['-t', t]
38 ans += ['-d', j(base, 'doctrees'), BASE, destdir]
39 print(' '.join(ans))
40 subprocess.check_call(ans)
41 return destdir
42
43
44 def build_manual(language, base):
45 sb = partial(sphinx_build, language, base)
46 onlinedir = sb(t='online')
47 epubdir = sb('myepub', 'epub')
48 pdf_ok = language not in ('ja', 'ar')
49 if pdf_ok:
50 latexdir = sb('latex', 'latex')
51 pwd = os.getcwd()
52 os.chdir(latexdir)
53
54 def run_cmd(cmd):
55 p = subprocess.Popen(cmd, stdout=open(os.devnull, 'wb'), stdin=subprocess.PIPE)
56 assert p.stdin is not None
57 p.stdin.close()
58 return p.wait()
59
60 try:
61 for i in range(3):
62 run_cmd(['xelatex', '-interaction=nonstopmode', 'calibre.tex'])
63 run_cmd(['makeindex', '-s', 'python.ist', 'calibre.idx'])
64 for i in range(2):
65 run_cmd(['xelatex', '-interaction=nonstopmode', 'calibre.tex'])
66 if not os.path.exists('calibre.pdf'):
67 print('Failed to build pdf file, see calibre.log in the latex directory', file=sys.stderr)
68 raise SystemExit(1)
69 finally:
70 os.chdir(pwd)
71 pdf_dest = j(onlinedir, 'calibre.pdf')
72 shutil.copyfile(j(latexdir, 'calibre.pdf'), pdf_dest)
73 epub_dest = j(onlinedir, 'calibre.epub')
74 shutil.copyfile(j(epubdir, 'calibre.epub'), epub_dest)
75 epub_to_azw3(epub_dest)
76
77
78 def build_pot(base):
79 cmd = SPHINX_BUILD + ['-b', 'gettext', '-t', 'online', '-t', 'gettext', '.', base]
80 print(' '.join(cmd))
81 subprocess.check_call(cmd)
82 os.remove(j(base, 'generated.pot'))
83 return base
84
85
86 def build_linkcheck(base):
87 cmd = SPHINX_BUILD + ['-b', 'linkcheck', '-t', 'online', '-t', 'linkcheck', '.', base]
88 print(' '.join(cmd))
89 subprocess.check_call(cmd)
90 return base
91
92
93 def build_man_pages(language, base):
94 os.environ['CALIBRE_BUILD_MAN_PAGES'] = '1'
95 sphinx_build(language, base, builder='man', bdir=language, very_quiet=True)
96
97
98 if __name__ == '__main__':
99 import argparse
100
101 os.chdir(d(a(__file__)))
102 os.environ['__appname__'] = __appname__
103 os.environ['__version__'] = __version__
104 if len(sys.argv) == 1:
105 base = j(tempfile.gettempdir(), 'manual')
106 os.environ['CALIBRE_OVERRIDE_LANG'] = language = 'en'
107 if 'ALL_USER_MANUAL_LANGUAGES' not in os.environ:
108 import json
109
110 os.environ['ALL_USER_MANUAL_LANGUAGES'] = ' '.join(json.load(open('locale/completed.json', 'rb')))
111 sphinx_build(language, base, t='online', quiet=False)
112 print('Manual built in', j(base, 'html'))
113 else:
114 p = argparse.ArgumentParser()
115 p.add_argument('language', help='The language to build for')
116 p.add_argument('base', help='The destination directory')
117 p.add_argument('--man-pages', default=False, action='store_true', help='Build man pages')
118 p.add_argument('--quiet', default=False, action='store_true', help='Suppress warnings')
119 args = p.parse_args()
120 language, base = args.language, args.base
121 if language == 'gettext':
122 build_pot(base)
123 elif language == 'linkcheck':
124 build_linkcheck(base)
125 elif args.man_pages:
126 os.environ['CALIBRE_OVERRIDE_LANG'] = language
127 build_man_pages(language, base)
128 else:
129 os.environ['CALIBRE_OVERRIDE_LANG'] = language
130 build_manual(language, base)
131 print('Manual for', language, 'built in', j(base, 'html'))