From ff4d6699faafa7af52876412a24b0dde5cb0ad26 Mon Sep 17 00:00:00 2001 From: James Teh Date: Wed, 30 Nov 2011 09:45:51 +1000 Subject: [PATCH] sconstruct: Add output\devDocs\nvda target to generate documentation for the NVDA Python code using Epydoc. --- sconstruct | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/sconstruct b/sconstruct index 364963fd1..7298d3439 100755 --- a/sconstruct +++ b/sconstruct @@ -55,6 +55,9 @@ except WindowsError: # Get the path to pygettext. pygettext = os.path.join(sys.exec_prefix, "Tools", "i18n", "pygettext.py") +# Get the path to epydoc. +EPYDOC = os.path.join(sys.exec_prefix, "scripts", "epydoc.py") + def keyCommandsDocTool(env): import keyCommandsDoc kcdAction=env.Action( @@ -286,6 +289,17 @@ def makePot(target, source, env): devDocs_nvdaHelper_temp=env.Doxygen(source='nvdaHelper/doxyfile') devDocs_nvdaHelper=env.Command(devDocsOutputDir.Dir('nvdaHelper'),devDocs_nvdaHelper_temp,Move('$TARGET','$SOURCE')) +devDocs_nvda = env.Command(devDocsOutputDir.Dir("nvda"), None, [[ + "cd", sourceDir.path, "&&", + sys.executable, EPYDOC, + "--output", "${TARGET.abspath}", + "--quiet", "--html", "--include-log", "--no-frames", + "--name", "NVDA", "--url", "http://www.nvda-project.org/", + "*.py", "appModules", "brailleDisplayDrivers", r"comInterfaces\__init__.py", + "config", "globalPlugins", "gui", "NVDAObjects", + "synthDrivers", "textInfos", "virtualBuffers", +]]) + env.Alias('devDocs',devDocsOutputDir) env.Clean('devDocs',devDocsOutputDir) -- 2.11.0