From: James Teh <jamie@jantrid.net>
Date: Mon, 21 Jan 2013 07:04:55 +0000 (+1000)
Subject: Dev docs building changes:
X-Git-Tag: jpdev130418~268
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=e10bd0ced0b644bf11e7ebbd60999bdd3b903779;p=nvdajp%2Fnvdajp.git

Dev docs building changes:
* Exclude nvdaHelper from scons devDocs and instead create a separate devDocs_nvdaHelper target, since this is very complex internal stuff that most developers aren't interested in.
* Add info about Epydoc dependency to the source readme.
Fixes #2421.
---

diff --git a/readme.txt b/readme.txt
index 8415bb2a2..42d0d7125 100644
--- a/readme.txt
+++ b/readme.txt
@@ -94,6 +94,12 @@ To build a binary version of NVDA:
 		* Copy both ansi\uac.dll and uac.nsh into the uninstaller directory.
 
 To generate developer documentation:
+	* epydoc, version 3.0.1:
+		* Official web site: http://epydoc.sourceforge.net/
+		* Epydoc is no longer being maintained, but there is a bug in version 3.0.1 which affects NVDA.
+		* A build including a fix for this bug can be found at: http://files.nvaccess.org/3rdParty/epydoc-3.0.1+bug2585292.win32.exe
+
+To generate developer documentation for nvdaHelper:
 	* Doxygen Windows installer (1.7.3 or above): http://www.stack.nl/~dimitri/doxygen/download.html 
 
 To generate a gettext translation template:
@@ -142,6 +148,10 @@ To generate developer documentation, type:
 scons devDocs
 The developer docs will be placed in the devDocs folder in the output directory.
 
+To generate developer documentation for nvdaHelper (not included in the devDocs target):
+scons devDocs_nvdaHelper
+The documentation will be placed in the devDocs\nvdaHelper folder in the output directory.
+
 To generate an archive of debug symbols for the various dll/exe binaries, type:
 scons symbolsArchive
 The archive will be placed in the output directory.
diff --git a/sconstruct b/sconstruct
index 426ef0a87..9a42ddf94 100755
--- a/sconstruct
+++ b/sconstruct
@@ -291,6 +291,8 @@ 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'))
+env.Alias('devDocs_nvdaHelper', devDocs_nvdaHelper)
+env.Clean('devDocs_nvdaHelper', devDocs_nvdaHelper)
 
 devDocs_nvda = env.Command(devDocsOutputDir.Dir("nvda"), None, [[
 	"cd", sourceDir.path, "&&",
@@ -303,8 +305,8 @@ devDocs_nvda = env.Command(devDocsOutputDir.Dir("nvda"), None, [[
 	"synthDrivers", "textInfos", "virtualBuffers",
 ]])
 
-env.Alias('devDocs',devDocsOutputDir)
-env.Clean('devDocs',devDocsOutputDir)
+env.Alias('devDocs', [devGuide, devDocs_nvda])
+env.Clean('devDocs', [devGuide, devDocs_nvda])
 
 pot = env.Command(outputDir.File("%s.pot" % outFilePrefix),
 	# Don't use sourceDir as the source, as this depends on comInterfaces and nvdaHelper.