013e5c94d6
- Windows paths must be escaped - Regex should use raw strings Signed-off-by: Tim Crawford <tcrawford@system76.com>
Prerequisite Tools:
- Install Python 2.7.3 from https://www.python.org/download/releases/2.7.3/
- Install wxPython 2.8.12.1 from https://sourceforge.net/projects/wxpython/files/wxPython/2.8.12.1/ generally the libraries will be installed at python's subfolder, for example in windows: c:\python27\Lib\site-packages\
- Install DoxyGen 1.8.6 from https://sourceforge.net/projects/doxygen/files/rel-1.8.6/
- (Windows only) Install Htmlhelp tool from https://msdn.microsoft.com/en-us/library/windows/desktop/ms669985(v=vs.85).aspx
Limitation:
- Current tool doesn't work on latest wxPython and DoxyGen tool. Please use the sepecific version in above.
Run the Tool: a) Run with GUI:
- Enter src folder, double click "packagedocapp.pyw" or run command "python packagedocapp.pyw" to open the GUI.
- Make sure all the information in blank are correct.
- Click "Generate Package Document!" b) Run with command line:
- Open command line window
- Enter src folder, for example: "cd C:\PackageDocumentTools\src"
- Run "python packagedoc_cli.py --help" for detail command.