diff --git a/Mac/OSX/setupDocs.py b/Mac/OSX/setupDocs.py new file mode 100644 index 00000000000..b15ed1f8272 --- /dev/null +++ b/Mac/OSX/setupDocs.py @@ -0,0 +1,166 @@ +# Build and install an Apple Help Viewer compatible version of the Python +# documentation into the framework. +# Code by Bill Fancher, with some modifications by Jack Jansen. +# +# You must run this as a two-step process +# 1. python setupDocs.py build +# 2. Wait for Apple Help Indexing Tool to finish +# 3. python setupDocs.py install +# +# To do: +# - test whether the docs are available locally before downloading +# - fix buildDocsFromSource +# - Get documentation version from sys.version, fallback to 2.2.1 +# - See if we can somehow detect that Apple Help Indexing Tool is finished +# - data_files to setup() doesn't seem the right way to pass the arguments +# +import sys, os, re +from distutils.cmd import Command +from distutils.command.build import build +from distutils.core import setup +from distutils.file_util import copy_file +from distutils.dir_util import copy_tree +from distutils.log import log +from distutils.spawn import spawn +from distutils import sysconfig, dep_util + +def visit(arg, d,l): + for f in l: + arg.hackFile(d,f) + +class DocBuild(build): + def initialize_options(self): + build.initialize_options(self) + self.doc_dir = None + self.base_dir = None + self.build_dir = None + self.download = 1 + self.doc_version = '2.2.1' + + def finalize_options(self): + build.finalize_options(self) + if self.build_dir is None: + self.build_dir = self.build_temp + if self.doc_dir is None: + self.doc_dir = data_info = self.distribution.data_files[0][1][0] + self.build_dest = os.path.abspath(os.path.join(self.build_dir,self.doc_dir)) + #print 'DocBuild.finalize_options:\n build_dest = %s,\n doc_dir = %s' % (self.build_dest, self.doc_dir) + + def spawn(self, *args): + spawn(args, 1, self.verbose, self.dry_run) + + def downloadDocs(self): + workdir = os.getcwd() + self.spawn('curl','-O', 'http://www.python.org/ftp/python/doc/%s/html-%s.tgz' % (self.doc_version,self.doc_version)) + self.mkpath(self.doc_dir) + os.chdir(self.doc_dir) + self.spawn('tar', '-xzf', '../html-%s.tgz' % self.doc_version) + os.chdir(workdir); + + def buildDocsFromSouce(self): + #Totally untested + spawn(('make','--directory', '../Docs'), 1, self.verbose, self.dry_run) + copy_tree('../Docs/html', self.doc_dir) + + def ensureHtml(self): + if not os.path.exists(self.doc_dir): + if self.download: + self.downloadDocs() + else: + self.buildDocsFromSource() + + def hackIndex(self): + ind_html = 'index.html' + #print 'self.build_dest =', self.build_dest + hackedIndex = file(os.path.join(self.build_dest, ind_html),'w') + origIndex = file(os.path.join(self.doc_dir,ind_html)) + r = re.compile('', re.DOTALL) + hackedIndex.write(r.sub('',origIndex.read())) + + def hackFile(self,d,f): + origPath = os.path.join(d,f) + outPath = os.path.join(self.build_dir, d, f) + (name, ext) = os.path.splitext(f) + if os.path.isdir(origPath): + self.mkpath(outPath) + elif ext == '.html': + if self.verbose: print 'hacking %s to %s' % (origPath,outPath) + hackedFile = file(outPath, 'w') + origFile = file(origPath,'r') + hackedFile.write(self.r.sub('