mirror of
https://github.com/Relintai/scons_gd.git
synced 2025-02-04 16:16:00 +01:00
101 lines
3.8 KiB
Python
101 lines
3.8 KiB
Python
#
|
|
# Setup epydoc builder
|
|
#
|
|
|
|
#
|
|
# __COPYRIGHT__
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included
|
|
# in all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
|
|
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
|
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
# from Utilities import whereis
|
|
from SCons.Script import Delete, Touch, WhereIs
|
|
|
|
epydoc_cli = WhereIs('epydoc')
|
|
|
|
if not epydoc_cli:
|
|
try:
|
|
import epydoc
|
|
except ImportError:
|
|
epydoc = None
|
|
else:
|
|
# adding Epydoc builder using imported module
|
|
def epydoc_builder_action(target, source, env):
|
|
"""
|
|
Take a list of `source` files and build docs for them in
|
|
`target` dir.
|
|
|
|
`target` and `source` are lists.
|
|
|
|
Uses OUTDIR and EPYDOCFLAGS environment variables.
|
|
|
|
http://www.scons.org/doc/2.0.1/HTML/scons-user/x3594.html
|
|
"""
|
|
|
|
# the epydoc build process is the following:
|
|
# 1. build documentation index
|
|
# 2. feed doc index to writer for docs
|
|
|
|
from epydoc.docbuilder import build_doc_index
|
|
from epydoc.docwriter.html import HTMLWriter
|
|
# from epydoc.docwriter.latex import LatexWriter
|
|
|
|
# first arg is a list where can be names of python package dirs,
|
|
# python files, object names or objects itself
|
|
docindex = build_doc_index([str(src) for src in source])
|
|
if docindex is None:
|
|
return -1
|
|
|
|
if env['EPYDOCFLAGS'] == '--html':
|
|
html_writer = HTMLWriter(docindex,
|
|
docformat='restructuredText',
|
|
prj_name='SCons',
|
|
prj_url='http://www.scons.org/')
|
|
try:
|
|
html_writer.write(env['OUTDIR'])
|
|
except OSError: # If directory cannot be created or any file cannot
|
|
# be created or written to.
|
|
return -2
|
|
|
|
"""
|
|
# PDF support requires external Linux utilites, so it's not crossplatform.
|
|
# Leaving for now.
|
|
# http://epydoc.svn.sourceforge.net/viewvc/epydoc/trunk/epydoc/src/epydoc/cli.py
|
|
|
|
elif env['EPYDOCFLAGS'] == '--pdf':
|
|
pdf_writer = LatexWriter(docindex,
|
|
docformat='restructuredText',
|
|
prj_name='SCons',
|
|
prj_url='http://www.scons.org/')
|
|
"""
|
|
return 0
|
|
|
|
epydoc_commands = [
|
|
Delete('$OUTDIR'),
|
|
epydoc_builder_action,
|
|
Touch('$TARGET'),
|
|
]
|
|
|
|
else:
|
|
# epydoc_cli is found
|
|
epydoc_commands = [
|
|
Delete('$OUTDIR'),
|
|
'$EPYDOC $EPYDOCFLAGS --debug --output $OUTDIR --docformat=restructuredText --name SCons --url http://www.scons.org/ $SOURCES',
|
|
Touch('$TARGET'),
|
|
]
|