summaryrefslogtreecommitdiff
path: root/api-docs
diff options
context:
space:
mode:
authorXusheng <xusheng@vector35.com>2023-01-10 18:35:54 +0800
committerXusheng <xusheng@vector35.com>2023-01-10 18:35:54 +0800
commitc14db13ccfedf2e4f5e1fed02bd2217bebe7f1e2 (patch)
tree4cf85ce4b53b9e175c191a2a72a458f9296dad15 /api-docs
parentda6e583784879f845bc5d80861b695bb899557bf (diff)
Fix debugger Python docs generation
Diffstat (limited to 'api-docs')
-rw-r--r--api-docs/source/conf.py10
1 files changed, 8 insertions, 2 deletions
diff --git a/api-docs/source/conf.py b/api-docs/source/conf.py
index 9f495e2c..642cfce4 100644
--- a/api-docs/source/conf.py
+++ b/api-docs/source/conf.py
@@ -39,6 +39,7 @@ os.environ["BN_DISABLE_USER_SETTINGS"] = "True"
os.environ["BN_DISABLE_USER_PLUGINS"] = "True"
os.environ["BN_DISABLE_REPOSITORY_PLUGINS"] = "True"
import binaryninja
+import binaryninja.debugger
def modulelist(modulename):
modules = inspect.getmembers(modulename, inspect.ismodule)
@@ -49,7 +50,7 @@ def modulelist(modulename):
"associateddatastore", "range", "pyNativeStr", "cstr", "fnsignature",
"get_class_members", "datetime", "inspect", "subprocess", "site",
"string", "random", "uuid", "queue", "collections", "dbgcore", "debugger", "webbrowser",
- "dataclasses"]
+ "dataclasses", "_debuggercore"]
return sorted(set(x for x in modules if x[0] not in moduleblacklist))
def classlist(module):
@@ -101,7 +102,12 @@ Full Class List
''')
- for modulename, module in modulelist(binaryninja):
+ # Generate docs for both binaryninja and binaryninja.debugger module
+ modules = modulelist(binaryninja)
+ modules.extend(modulelist(binaryninja.debugger))
+ modules = sorted(modules)
+
+ for modulename, module in modules:
# Since we put debugger python files in a folder, binaryninja.{modulename} is no longer the
# correct name of the module
filename = f"{module.__name__}-module.rst"