import re
import string
-Import('env', 'whereis')
+Import('build_dir', 'env', 'whereis')
-env = env.Copy()
+env = env.Clone()
-env.TargetSignatures('content')
-
-build = os.path.join('#build', 'doc')
+build = os.path.join(build_dir, 'doc')
#
#
#
-doc_tar_gz = os.path.join('#build',
- 'dist',
- 'scons-doc-%s.tar.gz' % env.Dictionary('VERSION'))
+dist_doc_tar_gz = '$DISTDIR/scons-doc-${VERSION}.tar.gz'
#
# We'll only try to build text files (for some documents)
# if lynx is available to do the dump.
#
fig2dev = whereis('fig2dev')
+epydoc = whereis('epydoc')
groff = whereis('groff')
lynx = whereis('lynx')
man2html = whereis('man2html')
-jade = whereis('jade')
+jade_original = whereis('jade')
+jade = whereis('openjade') or jade_original
jadetex = whereis('jadetex')
pdfjadetex = whereis('pdfjadetex')
jw = whereis('jw')
format_re = re.compile(r'<(?:graphic|imagedata)\s+fileref="([^"]*)"(?:\s+format="([^"]*)")?')
#
-# Find internal dependencies in .sgml files:
+# Find internal dependencies in .xml files:
#
-# <!entity bground SYSTEM "bground.sgml">
+# <!entity bground SYSTEM "bground.xml">
# <graphic fileref="file.jpg">
# <imagedata fileref="file.jpg">
#
# defined as a SYSTEM entity is, in fact, a file included
# somewhere in the document.
#
-def scansgml(node, env, target):
+def scanxml(node, env, target):
includes = []
contents = node.get_contents()
return includes
-s = Scanner(name = 'sgml', function = scansgml, skeys = ['.sgml', '.mod'])
+s = Scanner(name = 'xml', function = scanxml, skeys = ['.xml', '.mod'])
orig_env = env
-env = orig_env.Copy(SCANNERS = [s],
- SCONS_PROC_PY = File('#bin/scons-proc.py').rfile(),
- SCONSOUTPUT_PY = File('#bin/sconsoutput.py').rfile())
+env = orig_env.Clone(SCANNERS = [s],
+ SCONS_PROC_PY = File('#bin/scons-proc.py').rfile(),
+ SCONSOUTPUT_PY = File('#bin/sconsoutput.py').rfile())
# Fetch the list of files in the build engine that contain
# SCons documentation XML for processing.
scons_doc_files = map(chop, open(manifest_xml_in).readlines())
scons_doc_files = map(lambda x: File('#src/engine/'+x).rstr(), scons_doc_files)
-if jw:
+if not jw:
+ print "jw not found, skipping building User Guide."
+else:
#
- # Always create a version.sgml file containing the version information
+ # Always create a version.xml file containing the version information
# for this run. Ignore it for dependency purposes so we don't
# rebuild all the docs every time just because the date changes.
#
date, ver, rev = env.Dictionary('DATE', 'VERSION', 'REVISION')
- version_sgml = File(os.path.join(build, "version.sgml"))
- #version_sgml = File("version.sgml")
- verfile = str(version_sgml)
+ version_xml = File(os.path.join(build, "version.xml"))
+ #version_xml = File("version.xml")
+ verfile = str(version_xml)
try:
os.unlink(verfile)
except OSError:
variables_gen, variables_mod]
b = env.Command(doc_output_files,
scons_doc_files,
- "python $SCONS_PROC_PY --sgml -b ${TARGETS[0]},${TARGETS[1]} -t ${TARGETS[2]},${TARGETS[3]} -v ${TARGETS[4]},${TARGETS[5]} $( $SOURCES $)")
+ "$PYTHON $SCONS_PROC_PY --xml -b ${TARGETS[0]},${TARGETS[1]} -t ${TARGETS[2]},${TARGETS[3]} -v ${TARGETS[4]},${TARGETS[5]} $( $SOURCES $)")
env.Depends(b, "$SCONS_PROC_PY")
env.Local(b)
'pdf' : 1,
'text' : 0,
},
+ # For whenever (if ever?) we start putting developer guide
+ # information in a printable document instead of the wiki.
+ #'developer' : {
+ # 'htmlindex' : 'book1.html',
+ # 'html' : 1,
+ # 'ps' : 1,
+ # 'pdf' : 1,
+ # 'text' : 0,
+ #},
'user' : {
'htmlindex' : 'book1.html',
'html' : 1,
'ps' : 1,
'pdf' : 1,
- 'text' : 0,
+ 'text' : 1,
'graphics' : [
'SCons-win32-install-1.jpg',
'SCons-win32-install-2.jpg',
}
#
- # We have to tell SCons to scan the top-level SGML files which
- # get included by the document SGML files in the subdirectories.
+ # We have to tell SCons to scan the top-level XML files which
+ # get included by the document XML files in the subdirectories.
#
manifest = File('MANIFEST').rstr()
src_files = map(lambda x: x[:-1], open(manifest).readlines())
if ext in ['.fig', '.jpg']:
orig_env.InstallAs(build_s, doc_s)
else:
- if build_doc and ext == '.sgml':
+ if build_doc and ext == '.xml':
env.Command(doc_s,
base + '.in',
- "python $SCONSOUTPUT_PY $SOURCE > $TARGET")
+ "$PYTHON $SCONSOUTPUT_PY $SOURCE > $TARGET")
orig_env.SCons_revision(build_s, doc_s)
Local(build_s)
- main = os.path.join(build, doc, 'main.sgml')
+ main = os.path.join(build, doc, 'main.xml')
out = 'main.out'
# Hard-coding the scons-src path is a bit of a hack. This can
# be reworked when a better solution presents itself.
- scons_src_main = os.path.join('#build', 'scons-src', 'doc', main)
- env.Ignore(scons_src_main, version_sgml)
+ scons_src_main = os.path.join(build_dir, 'scons-src', 'doc', main)
+ env.Ignore(scons_src_main, version_xml)
htmldir = os.path.join(build, 'HTML', 'scons-%s' % doc)
htmlindex = os.path.join(htmldir, docs[doc]['htmlindex'])
text = os.path.join(build, 'TEXT', 'scons-%s.txt' % doc)
if docs[doc].get('html') and jade:
+ def copy_index_html(target, source, env):
+ # Older versions of DocBook|jw|jade|whatever would
+ # create a book1.html file, while newer versions create
+ # an index.html file (logically enough). The scons.org
+ # web site links expect book1.html, so we're going to
+ # leave the target as is, and run this post-processing
+ # action function to check that the target really did
+ # get created, and if it didn't, copy it from index.html.
+ t = str(target[0])
+ if not os.path.exists(t):
+ i = os.path.join(os.path.split(t)[0], 'index.html')
+ open(t, 'w').write(open(i, 'r').read())
+ return None
+
cmds = [
Delete("${TARGET.dir}/*.html"),
"jw -b html -o ${TARGET.dir} $SOURCES",
]
if tidy:
cmds.append("tidy -m -q $TARGET || true")
- env.Command(htmlindex, main, cmds)
+ cmds.append(Action(copy_index_html))
+ env.Command(htmlindex, File(main), cmds)
Local(htmlindex)
cmds = [
]
if tidy:
cmds.append("tidy -m -q $TARGET || true")
- env.Command(html, main, cmds)
+ env.Command(html, File(main), cmds)
Local(html)
- env.Ignore([html, htmlindex], version_sgml)
+ env.Ignore([html, htmlindex], version_xml)
tar_deps.extend([html, htmlindex])
tar_list.extend([html, htmldir])
src = os.path.join(build, doc, g)
Local(env.Install(htmldir, src))
- if docs[doc].get('ps') and jadetex:
+ if docs[doc].get('ps') and jadetex and jade_original:
env.Command(ps, main, [
Delete("${TARGET.dir}/%s" % out),
- "jw -b ps -o ${TARGET.dir} $SOURCES",
+ "jw -b ps -o ${TARGET.dir} -p %s $SOURCES" % jade_original,
"mv ${TARGET.dir}/main.ps $TARGET",
Delete("${TARGET.dir}/%s" % out),
])
Local(ps)
- env.Ignore(ps, version_sgml)
+ env.Ignore(ps, version_xml)
tar_deps.append(ps)
tar_list.append(ps)
src = os.path.join(build, doc, g)
Local(env.Install(htmldir, src))
- if docs[doc].get('pdf') and pdfjadetex:
+ if docs[doc].get('pdf') and pdfjadetex and jade_original:
env.Command(pdf, main, [
Delete("${TARGET.dir}/%s" % out),
- "jw -b pdf -o ${TARGET.dir} $SOURCES",
+ "jw -b pdf -o ${TARGET.dir} -p %s $SOURCES" % jade_original,
"mv ${TARGET.dir}/main.pdf $TARGET",
Delete("${TARGET.dir}/out"),
])
Local(pdf)
- env.Ignore(pdf, version_sgml)
+ env.Ignore(pdf, version_xml)
tar_deps.append(pdf)
tar_list.append(pdf)
env.Command(text, html, "lynx -dump ${SOURCE.abspath} > $TARGET")
Local(text)
- env.Ignore(text, version_sgml)
+ env.Ignore(text, version_xml)
tar_deps.append(text)
tar_list.append(text)
#
# Man page(s), in good ol' troff format.
#
-man_page_list = ['scons.1', 'sconsign.1']
+man_page_list = ['scons.1', 'sconsign.1', 'scons-time.1']
for m in man_page_list:
- orig_env.SCons_revision(os.path.join(build, 'man', m),
+ x = orig_env.SCons_revision(os.path.join(build, 'man', m),
os.path.join('man', m))
-man_intermediate_files = ['builders.man', 'tools.man', 'variables.man']
+man_i_files = ['builders.man', 'tools.man', 'variables.man']
man_intermediate_files = map(lambda x: os.path.join(build, 'man', x),
- man_intermediate_files)
+ man_i_files)
-cmd = "python $SCONS_PROC_PY --man -b ${TARGETS[0]} -t ${TARGETS[1]} -v ${TARGETS[2]} $( $SOURCES $)"
+cmd = "$PYTHON $SCONS_PROC_PY --man -b ${TARGETS[0]} -t ${TARGETS[1]} -v ${TARGETS[2]} $( $SOURCES $)"
man_intermediate_files = env.Command(man_intermediate_files,
scons_doc_files,
cmd)
if man2html:
html = os.path.join(build, 'HTML' , '%s-man.html' % man)
- cmds = [ "( cd ${SOURCES.dir} && man2html ${SOURCES.dir} ) > $TARGET" ]
+ def strip_to_first_html_tag(target, source, env):
+ t = str(target[0])
+ contents = open(t).read()
+ contents = contents[string.find(contents, '<HTML>'):]
+ open(t, 'w').write(contents)
+ return 0
+
+ cmds = [
+ "( cd %s/man && cp %s .. )" % (build, string.join(man_i_files)),
+ "( cd ${SOURCE.dir} && man2html ${SOURCE.file} ) > $TARGET",
+ Action(strip_to_first_html_tag),
+ ]
if tidy:
cmds.append("tidy -m -q $TARGET || true")
b = env.Command(html, man_1, cmds)
tar_deps.append(html)
tar_list.append(html)
+if not epydoc:
+ print "epydoc not found, skipping building API documentation."
+else:
+ # XXX Should be in common with reading the same thing in
+ # the SConstruct file.
+ e = os.path.join('#src', 'engine')
+ manifest_in = File(os.path.join(e, 'MANIFEST.in')).rstr()
+ sources = map(lambda x: x[:-1], open(manifest_in).readlines())
+ sources = filter(lambda x: string.find(x, 'Optik') == -1, sources)
+ sources = filter(lambda x: string.find(x, 'Platform') == -1, sources)
+ sources = filter(lambda x: string.find(x, 'Tool') == -1, sources)
+ # XXX
+ sources = filter(lambda x: string.find(x, 'Options') == -1, sources)
+
+ e = os.path.join(build, '..', 'scons', 'engine')
+ sources = map(lambda x, e=e: os.path.join(e, x), sources)
+
+ epydoc_commands = [
+ Delete('$OUTDIR'),
+ '$EPYDOC $EPYDOCFLAGS --debug --output $OUTDIR --docformat=restructuredText --name SCons --url http://www.scons.org/ $SOURCES',
+ Touch('$TARGET'),
+ ]
+
+ htmldir = os.path.join(build, 'HTML', 'scons-api')
+ env.Command('${OUTDIR}/index.html', sources, epydoc_commands,
+ EPYDOC=epydoc, EPYDOCFLAGS='--html', OUTDIR=htmldir)
+ tar_deps.append(htmldir)
+ tar_list.append(htmldir)
+
+ # PDF and PostScript and TeX are built from the
+ # same invocation.
+ api_dir = os.path.join(build, 'scons-api')
+ api_pdf = os.path.join(api_dir, 'api.pdf')
+ api_ps = os.path.join(api_dir, 'api.ps')
+ api_tex = os.path.join(api_dir, 'api.tex')
+ api_targets = [api_pdf, api_ps, api_tex]
+ env.Command(api_targets, sources, epydoc_commands,
+ EPYDOC=epydoc, EPYDOCFLAGS='--pdf', OUTDIR=api_dir)
+ Local(api_targets)
+
+ pdf_install = os.path.join(build, 'PDF', 'scons-api.pdf')
+ env.InstallAs(pdf_install, api_pdf)
+ tar_deps.append(pdf_install)
+ tar_list.append(pdf_install)
+ Local(pdf_install)
+
+ ps_install = os.path.join(build, 'PS', 'scons-api.ps')
+ env.InstallAs(ps_install, api_ps)
+ tar_deps.append(ps_install)
+ tar_list.append(ps_install)
+ Local(ps_install)
+
#
# Now actually create the tar file of the documentation,
# for easy distribution to the web site.
#
if tar_deps:
- tar_list = string.join(map(lambda x: x[11:], tar_list))
- env.Command(doc_tar_gz, tar_deps,
- "tar cf${TAR_HFLAG} - -C build/doc %s | gzip > $TARGET" % tar_list)
- Local(doc_tar_gz)
+ tar_list = string.join(map(lambda x, b=build+'/': string.replace(x, b, ''),
+ tar_list))
+ t = env.Command(dist_doc_tar_gz, tar_deps,
+ "tar cf${TAR_HFLAG} - -C %s %s | gzip > $TARGET" % (build, tar_list))
+ AddPostAction(dist_doc_tar_gz, Chmod(dist_doc_tar_gz, 0644))
+ Local(t)
+ Alias('doc', t)
+else:
+ Alias('doc', os.path.join(build_dir, 'doc'))
projects / scons.git / blobdiff