tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
audk/BaseTools/Scripts/PackageDocumentTools
History
Liming Gao 1ccc4d895d Revert BaseTools: PYTHON3 migration 
This reverts commit 6693f359b3c213513c5096a06c6f67244a44dc52..
678f851312.

Python3 migration is the fundamental change. It requires every developer
to install Python3. Before this migration, the well communication and wide
verification must be done. But now, most people is not aware of this change,
and not try it. So, Python3 migration is reverted and be moved to edk2-staging
Python3 branch for the edk2 user evaluation.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Liming Gao <liming.gao@intel.com>
 		2018-10-15 08:29:14 +08:00
..
plugins Revert BaseTools: PYTHON3 migration 2018-10-15 08:29:14 +08:00
Readme.md Revert BaseTools: PYTHON3 migration 2018-10-15 08:29:14 +08:00
__init__.py BaseTools: Add PackageDocumentTools into Scripts folder 2018-03-19 09:19:36 +08:00
packagedoc_cli.py Revert BaseTools: PYTHON3 migration 2018-10-15 08:29:14 +08:00
packagedocapp.pyw Revert BaseTools: PYTHON3 migration 2018-10-15 08:29:14 +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.