calibre/manual/build.py
2025-01-24 11:14:16 +01:00

128 lines
4.3 KiB
Python
Executable File

#!/usr/bin/env python
__license__ = 'GPL v3'
__copyright__ = '2014, Kovid Goyal <kovid at kovidgoyal.net>'
import os
import shutil
import subprocess
import sys
import tempfile
from functools import partial
j, d, a = os.path.join, os.path.dirname, os.path.abspath
BASE = d(a(__file__))
SPHINX_BUILD = ['sphinx-build']
sys.path.insert(0, d(BASE))
from setup import __appname__, __version__
sys.path.remove(d(BASE))
from calibre.ebooks.oeb.polish.container import epub_to_azw3
def sphinx_build(language, base, builder='html', bdir='html', t=None, quiet=True, very_quiet=False):
destdir = j(base, bdir)
if not os.path.exists(destdir):
os.makedirs(destdir)
ans = SPHINX_BUILD + ['-D', ('language=' + language), '-b', builder]
if quiet:
ans.append('-q')
if very_quiet:
ans.append('-Q')
if builder == 'html':
ans += ['-w', j(destdir, 'sphinx-build-warnings.txt')]
if t:
ans += ['-t', t]
ans += ['-d', j(base, 'doctrees'), BASE, destdir]
print(' '.join(ans))
subprocess.check_call(ans)
return destdir
def build_manual(language, base):
sb = partial(sphinx_build, language, base)
onlinedir = sb(t='online')
epubdir = sb('myepub', 'epub')
pdf_ok = language not in ('ja',)
if pdf_ok:
latexdir = sb('latex', 'latex')
pwd = os.getcwd()
os.chdir(latexdir)
def run_cmd(cmd):
p = subprocess.Popen(cmd, stdout=open(os.devnull, 'wb'), stdin=subprocess.PIPE)
p.stdin.close()
return p.wait()
try:
for i in range(3):
run_cmd(['xelatex', '-interaction=nonstopmode', 'calibre.tex'])
run_cmd(['makeindex', '-s', 'python.ist', 'calibre.idx'])
for i in range(2):
run_cmd(['xelatex', '-interaction=nonstopmode', 'calibre.tex'])
if not os.path.exists('calibre.pdf'):
print('Failed to build pdf file, see calibre.log in the latex directory', file=sys.stderr)
raise SystemExit(1)
finally:
os.chdir(pwd)
pdf_dest = j(onlinedir, 'calibre.pdf')
shutil.copyfile(j(latexdir, 'calibre.pdf'), pdf_dest)
epub_dest = j(onlinedir, 'calibre.epub')
shutil.copyfile(j(epubdir, 'calibre.epub'), epub_dest)
epub_to_azw3(epub_dest)
def build_pot(base):
cmd = SPHINX_BUILD + ['-b', 'gettext', '-t', 'online', '-t', 'gettext', '.', base]
print(' '.join(cmd))
subprocess.check_call(cmd)
os.remove(j(base, 'generated.pot'))
return base
def build_linkcheck(base):
cmd = SPHINX_BUILD + ['-b', 'linkcheck', '-t', 'online', '-t', 'linkcheck', '.', base]
print(' '.join(cmd))
subprocess.check_call(cmd)
return base
def build_man_pages(language, base):
os.environ['CALIBRE_BUILD_MAN_PAGES'] = '1'
sphinx_build(language, base, builder='man', bdir=language, very_quiet=True)
if __name__ == '__main__':
import argparse
os.chdir(d(a(__file__)))
os.environ['__appname__'] = __appname__
os.environ['__version__'] = __version__
if len(sys.argv) == 1:
base = j(tempfile.gettempdir(), 'manual')
os.environ['CALIBRE_OVERRIDE_LANG'] = language = 'en'
if 'ALL_USER_MANUAL_LANGUAGES' not in os.environ:
import json
os.environ['ALL_USER_MANUAL_LANGUAGES'] = ' '.join(json.load(open('locale/completed.json', 'rb')))
sphinx_build(language, base, t='online', quiet=False)
print('Manual built in', j(base, 'html'))
else:
p = argparse.ArgumentParser()
p.add_argument('language', help='The language to build for')
p.add_argument('base', help='The destination directory')
p.add_argument('--man-pages', default=False, action='store_true', help='Build man pages')
p.add_argument('--quiet', default=False, action='store_true', help='Suppress warnings')
args = p.parse_args()
language, base = args.language, args.base
if language == 'gettext':
build_pot(base)
elif language == 'linkcheck':
build_linkcheck(base)
elif args.man_pages:
os.environ['CALIBRE_OVERRIDE_LANG'] = language
build_man_pages(language, base)
else:
os.environ['CALIBRE_OVERRIDE_LANG'] = language
build_manual(language, base)
print('Manual for', language, 'built in', j(base, 'html'))