From: W. Trevor King Date: Sun, 9 May 2010 15:30:14 +0000 (-0400) Subject: Updated to doc building framework. Added Sphinx extensions and fixed genrst dependency X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=a8b46c746eb199900f1966d7e8a35e4f762485ac;p=hooke.git Updated to doc building framework. Added Sphinx extensions and fixed genrst dependency --- diff --git a/doc/SConstruct b/doc/SConstruct index fb1abe5..b416976 100644 --- a/doc/SConstruct +++ b/doc/SConstruct @@ -104,6 +104,8 @@ env = Environment(ENV = {"PATH" : os.environ["PATH"]}, TEX = "latex", PDFTEX = "pdflatex", tools = ['default', 'packaging'], variables = config) +if 'PYTHONPATH' in os.environ: + env['ENV']['PYTHONPATH'] = os.environ['PYTHONPATH'] # Get configuration values from environment. sphinxconf = env["config"] @@ -192,11 +194,13 @@ if texfilename: Help("Build targets:\n\n") if genrst != None: - source = env.Command('source', [], genrst) + source = env.Command('source', [], genrst, chdir = True) env.AlwaysBuild(source) env.Depends(srcdir, source) else: - Alias('source', srcdir) + source = env.Command( + 'source', [], + '@echo "No reStructuredText generator (genrst) given."') for name, desc in targets: target = Dir(name, builddir) @@ -206,8 +210,9 @@ for name, desc in targets: pass elif name not in latex_builders: # Standard Sphinx target. - env.Command(name, sphinxconf, - sphinxcmd % locals(), chdir = True) + targets = env.Command(name, sphinxconf, + sphinxcmd % locals(), chdir = True) + env.Depends(targets, source) env.AlwaysBuild(name) env.Alias(target, name) elif texinput: @@ -220,7 +225,8 @@ for name, desc in targets: filename = project_tag + "." + name outfile = File(filename, latexdir) - buildfunc(outfile, texinput) + targets = buildfunc(outfile, texinput) + env.Depends(targets, source) # Copy built file to separate directory. target = File(filename, target) diff --git a/doc/conf.py b/doc/conf.py index dd29ec5..d469d8b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -25,7 +25,8 @@ import hooke # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage', + 'numpydoc'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/doc/generate-hooke-txt.py b/doc/generate-hooke-txt.py index 0f7dd5c..653c1a6 100644 --- a/doc/generate-hooke-txt.py +++ b/doc/generate-hooke-txt.py @@ -317,4 +317,5 @@ def python_tree(root_path='hooke', root_modname='hooke'): if __name__ == '__main__': pt = python_tree(root_path='../hooke', root_modname='hooke') for node in pt.traverse(): + print node.modname make_module_txt(node.modname, [c.modname for c in node])