OSDN Git Service

Move generation of html documentation from t2t files (including keyCommands) from...
authorMichael Curran <mick@kulgan.net>
Sun, 14 Nov 2010 22:31:46 +0000 (08:31 +1000)
committerMichael Curran <mick@kulgan.net>
Sun, 14 Nov 2010 22:31:46 +0000 (08:31 +1000)
commit6caad0b4ee2f73e1eaa10ba8cc205d81aa3e9f67
tree12702c35271d32df9cff24d4def854a016acb265
parent494392790ca947e41bacac0b2daa3da551f9a03b
Move generation of html documentation from t2t files (including keyCommands)  from source/generate.py and into scons:
*Add a t2t scons tool in which provides a builder called txt2tags which converts a given t2t source file in to  an html file. Note that the real txt2tags module must be able to be imported by scons, so it either needs to be in Python's site-packages, or in nvda's root directory (not in source).
*Move keyCommandsDoc.py from source in to nvda's root directory.
*keyCommandsDoc: the maker now takes an output filename, not just an input file name.
*keyCommandsDoc: the maker now generates the output in a temporary file (for now the output filename with two underscores after) and then if successfull renames to the appropriate name.  The documentation for this function stated that the file was only generated if successfull, which was not the case.
*Ad a keyCommandsDoc tool function to nvda's root sconstruct which provides a builder called keyCommandsDoc which generates a keyCommands t2t from a given userGuide t2t.
*NVDA's root sconstruct: keyCommands.t2t files will be built from all userGuide.t2t files in user_docs, excluding  languages that are in a special keyCommandsLangBlacklist (this is currently cs and ja). The blacklisted languages do not have the newer format for their user guide.
*NVDA's root sconstruct: build html files from all t2t files in user_docs, including any keyCommands.t2t files.
*source/generate.py: remove now redundant code that generated keyCommands t2t files and converted t2t files to html files.
keyCommandsDoc.py [moved from source/keyCommandsDoc.py with 93% similarity]
sconstruct
site_scons/site_tools/t2t.py [new file with mode: 0644]
source/generate.py