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
99
100
101
102
103
104
105
106
107
108
109
110
|
#!/usr/bin/python3
# Copyright 2009 Canonical Ltd.
#
# 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 2 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
import os
import sys
import tarfile
from optparse import OptionParser
from shutil import copy2, copytree, rmtree
sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
def package_docs(section, src_build, dest_html, dest_downloads):
"""Package docs from a Sphinx _build directory into target directories.
:param section: section in the website being built
:param src_build: the _build directory
:param dest_html: the directory where html should go
:param downloads: the directory where downloads should go
"""
# Copy across the HTML. Explicitly delete the html destination
# directory first though because copytree insists on it not existing.
src_html = os.path.join(src_build, "html")
if os.path.exists(dest_html):
rmtree(dest_html)
copytree(src_html, dest_html)
# Package the html as a downloadable archive
archive_root = "brz-{}-html".format(section)
archive_basename = "{}.tar.bz2".format(archive_root)
archive_name = os.path.join(dest_downloads, archive_basename)
build_archive(src_html, archive_name, archive_root, "bz2")
# Copy across the PDF docs, if any, including the quick ref card
pdf_files = []
quick_ref = os.path.join(
src_html, "_static/{}/brz-{}-quick-reference.pdf".format(section, section)
)
if os.path.exists(quick_ref):
pdf_files.append(quick_ref)
src_pdf = os.path.join(src_build, "latex")
if os.path.exists(src_pdf):
for name in os.listdir(src_pdf):
if name.endswith(".pdf"):
pdf_files.append(os.path.join(src_pdf, name))
if pdf_files:
dest_pdf = os.path.join(dest_downloads, "pdf-{}".format(section))
if not os.path.exists(dest_pdf):
os.mkdir(dest_pdf)
for pdf in pdf_files:
copy2(pdf, dest_pdf)
# TODO: copy across the CHM files, if any
def build_archive(src_dir, archive_name, archive_root, format):
print("creating {} ...".format(archive_name))
tar = tarfile.open(archive_name, "w:{}".format(format))
for relpath in os.listdir(src_dir):
src_path = os.path.join(src_dir, relpath)
archive_path = os.path.join(archive_root, relpath)
tar.add(src_path, arcname=archive_path)
tar.close()
def main(argv):
# Check usage. The first argument is the parent directory of
# the Sphinx _build directory. It will typically be 'doc/xx'.
# The second argument is the website build directory.
parser = OptionParser(usage="%prog SOURCE-DIR WEBSITE-BUILD-DIR")
(options, args) = parser.parse_args(argv)
if len(args) != 2:
parser.print_help()
sys.exit(1)
# Get the section - locale code or 'developers'
src_dir = args[0]
section = os.path.basename(src_dir)
src_build = os.path.join(src_dir, "_build")
# Create the destination directories if they doesn't exist.
dest_dir = args[1]
dest_html = os.path.join(dest_dir, section)
dest_downloads = os.path.join(dest_dir, "downloads")
for d in [dest_dir, dest_downloads]:
if not os.path.exists(d):
print("creating directory {} ...".format(d))
os.mkdir(d)
# Package and copy the files across
package_docs(section, src_build, dest_html, dest_downloads)
if __name__ == "__main__":
main(sys.argv[1:])
|
