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
|
#!/usr/bin/env python
"""LaTeX Build Module"""
# Xnt -- A Wrapper Build Tool
# Copyright (C) 2013 Kenny Ballou
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program 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 General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import logging
import xnt.tasks
from xnt import VERBOSE
LOGGER = logging.getLogger(__name__)
def pdflatex(document,
path="./",
bibtex=False,
makeglossary=False):
"""Generate PDF LaTeX Document
:param document: Name of tex file (with or without `.tex` extension)
:param path: Directory of tex file, if different than current directory
:param bibtex: Flag to or not to add bibtex. Default: False
:param makeglossary: Flag to or not to add a glossary. Default: False
"""
devnull = None if VERBOSE else open(os.devnull, 'w')
documentbase = os.path.splitext(document)[0]
cwd = os.getcwd()
os.chdir(path)
def pdf(draftmode=False):
"""Generate PDF"""
cmd = ["pdflatex", document, "-halt-on-error",]
if draftmode:
cmd.append('-draftmode')
return xnt.tasks.call(cmd, stdout=devnull)
def run_bibtex():
"""Generate BibTex References"""
return xnt.tasks.call(["bibtex", documentbase + ".aux"],
stdout=devnull)
def makeglossaries():
"""Generate Glossary"""
return xnt.tasks.call(["makeglossaries", documentbase], stdout=devnull)
error_codes = []
error_codes.append(pdf(draftmode=True))
if makeglossary:
error_codes.append(makeglossaries())
if bibtex:
error_codes.append(run_bibtex())
error_codes.append(pdf(draftmode=True))
error_codes.append(pdf(draftmode=False))
os.chdir(cwd)
if devnull:
devnull.close()
return sum(error_codes)
def clean(path="./", remove_pdf=False):
"""Clean up generated files of PDF compilation
:param path: Directory of output files, if different than current directory
:param remove_pdf: Flag to remove the PDF. Default: False
"""
cwd = os.getcwd()
os.chdir(path)
xnt.tasks.rm("*.out",
"*.log",
"*.aux",
"*.toc",
"*.tol",
"*.tof",
"*.tot",
"*.bbl",
"*.blg",
"*.nav",
"*.snm",
"*.mtc",
"*.mtc0",
"*.glo",
"*.ist",
"*.glg",
"*.gls")
if remove_pdf:
xnt.tasks.rm("*.pdf")
os.chdir(cwd)
|
