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 8415bb2..42d0d71 100644 (file)
--- 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.\r
 \r
 To generate developer documentation:\r
+       * epydoc, version 3.0.1:\r
+               * Official web site: http://epydoc.sourceforge.net/\r
+               * Epydoc is no longer being maintained, but there is a bug in version 3.0.1 which affects NVDA.\r
+               * A build including a fix for this bug can be found at: http://files.nvaccess.org/3rdParty/epydoc-3.0.1+bug2585292.win32.exe\r
+\r
+To generate developer documentation for nvdaHelper:\r
        * Doxygen Windows installer (1.7.3 or above): http://www.stack.nl/~dimitri/doxygen/download.html \r
 \r
 To generate a gettext translation template:\r
@@ -142,6 +148,10 @@ To generate developer documentation, type:
 scons devDocs\r
 The developer docs will be placed in the devDocs folder in the output directory.\r
 \r
+To generate developer documentation for nvdaHelper (not included in the devDocs target):\r
+scons devDocs_nvdaHelper\r
+The documentation will be placed in the devDocs\nvdaHelper folder in the output directory.\r
+\r
 To generate an archive of debug symbols for the various dll/exe binaries, type:\r
 scons symbolsArchive\r
 The archive will be placed in the output directory.\r

diff --git a/sconstruct b/sconstruct
index 426ef0a..9a42ddf 100755 (executable)
--- a/sconstruct
+++ b/sconstruct
@@ -291,6 +291,8 @@ def makePot(target, source, env):
 \r
 devDocs_nvdaHelper_temp=env.Doxygen(source='nvdaHelper/doxyfile')\r
 devDocs_nvdaHelper=env.Command(devDocsOutputDir.Dir('nvdaHelper'),devDocs_nvdaHelper_temp,Move('$TARGET','$SOURCE'))\r
+env.Alias('devDocs_nvdaHelper', devDocs_nvdaHelper)\r
+env.Clean('devDocs_nvdaHelper', devDocs_nvdaHelper)\r
 \r
 devDocs_nvda = env.Command(devDocsOutputDir.Dir("nvda"), None, [[\r
        "cd", sourceDir.path, "&&",\r
@@ -303,8 +305,8 @@ devDocs_nvda = env.Command(devDocsOutputDir.Dir("nvda"), None, [[
        "synthDrivers", "textInfos", "virtualBuffers",\r
 ]])\r
 \r
-env.Alias('devDocs',devDocsOutputDir)\r
-env.Clean('devDocs',devDocsOutputDir)\r
+env.Alias('devDocs', [devGuide, devDocs_nvda])\r
+env.Clean('devDocs', [devGuide, devDocs_nvda])\r
 \r
 pot = env.Command(outputDir.File("%s.pot" % outFilePrefix),\r
        # Don't use sourceDir as the source, as this depends on comInterfaces and nvdaHelper.\r