Extract the doc ourselves if needed

Author: fmagin

generate_ghidra_pyi.py

@@ -19,24 +19,7 @@
 def main():
     # type: () -> None
     if not helper.are_docs_available():
-        continue_without_docs = askYesNo(
-            'Missing API Documentation',
-            'Ghidra API documentation is missing.\n'
-            'Documentation is required to generate docstrings,\n'
-            'argument names, and to find some of the classes.\n'
-            '\n'
-            'Would you like to continue without the API documentation?',
-        )
-
-        if not continue_without_docs:
-            print('Generation canceled: Missing API documentation.')
-            print('To make the API documentation available, ', end='')
-            print('click "Ghidra API Help" in the "Help" menu.')
-            print('Once the extraction is complete, re-run this script to generate the .pyi files.')
-            return
-
-        print('Continuing without API documentation. Expect partial results.')
-
+        helper.extract_jsondoc()
     try:
         pyi_root = askDirectory('.pyi root directory', 'Select').getPath()
         print(pyi_root)

generate_stub_package.py

@@ -9,7 +9,7 @@ def generate_package(pyi_root, ghidra_version):
 
 def find_stub_files():
     result = []
-    package = 'ghidra'
+    package = 'ghidra-stubs'
     for root, dirs, files in os.walk(package):
         for file in files:
             if file.endswith('.pyi'):

helper.py

@@ -1,4 +1,6 @@
 from __future__ import print_function
+
+import zipfile
 from collections import defaultdict
 import json
 import os
@@ -19,6 +21,15 @@ def get_jsondoc_basepath():
         'api',
     )
 
+def extract_jsondoc():
+    zip_location = os.path.join(Application.getInstallationDirectory().getAbsolutePath(), "docs/GhidraAPI_javadoc.zip")
+    extract_dir = os.path.join(
+        Application.getUserCacheDirectory().getAbsolutePath(),
+        'GhidraAPI_javadoc',
+        Application.getApplicationVersion())
+
+    zip_file = zipfile.ZipFile(zip_location)
+    zip_file.extractall(extract_dir)
 
 def are_docs_available():
     return os.path.exists(get_jsondoc_basepath())