audk/BaseTools/Scripts/PackageDocumentTools
Gary Lin 00eb12a2c7 BaseTools: Fix a typo in ini.py
"if mis not None:" => "if m is not None:"

Contributed-under: TianoCore Contribution Agreement 1.1
Cc: Jaben Carsey <jaben.carsey@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Gary Lin <glin@suse.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
2018-06-27 16:30:31 +08:00
..
plugins BaseTools: Fix a typo in ini.py 2018-06-27 16:30:31 +08:00
Readme.md BaseTools: Add PackageDocumentTools into Scripts folder 2018-03-19 09:19:36 +08:00
__init__.py BaseTools: Add PackageDocumentTools into Scripts folder 2018-03-19 09:19:36 +08:00
packagedoc_cli.py BaseTools: Remove equality operator with None 2018-03-30 08:25:13 +08:00
packagedocapp.pyw BaseTools: Add PackageDocumentTools into Scripts folder 2018-03-19 09:19:36 +08:00

Readme.md

Prerequisite Tools:

  1. Install Python 2.7.3 from https://www.python.org/download/releases/2.7.3/
  2. 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\
  3. Install DoxyGen 1.8.6 from https://sourceforge.net/projects/doxygen/files/rel-1.8.6/
  4. (Windows only) Install Htmlhelp tool from https://msdn.microsoft.com/en-us/library/windows/desktop/ms669985(v=vs.85).aspx

Limitation:

  1. 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:

  1. Enter src folder, double click "packagedocapp.pyw" or run command "python packagedocapp.pyw" to open the GUI.
  2. Make sure all the information in blank are correct.
  3. Click "Generate Package Document!" b) Run with command line:
  4. Open command line window
  5. Enter src folder, for example: "cd C:\PackageDocumentTools\src"
  6. Run "python packagedoc_cli.py --help" for detail command.