[Lldb-commits] [lldb] [lldb/docs] Breakdown python reference into multiple files (PR #158331)

[Dave Lee via lldb-commits]

================
@@ -0,0 +1,59 @@
+# Accessing Script Documentation
+
+The LLDB API is contained in a python module named lldb. A useful resource when
+writing Python extensions is the lldb Python classes reference guide.
+
+The documentation is also accessible in an interactive debugger session with
+the following command:
+
+```python3
+(lldb) script help(lldb)
+   Help on package lldb:
+
+   NAME
+      lldb - The lldb module contains the public APIs for Python binding.
+
+   FILE
+      /System/Library/PrivateFrameworks/LLDB.framework/Versions/A/Resources/Python/lldb/__init__.py
+
+   DESCRIPTION
+...
+```
+
+You can also get help using a module class name. The full API that is exposed
+for that class will be displayed in a man page style window. Below we want to
+get help on the lldb.SBFrame class:
+
+```python3
+(lldb) script help(lldb.SBFrame)
+   Help on class SBFrame in module lldb:
+
+   class SBFrame(__builtin__.object)
----------------
kastiglione wrote:

with python 3 this now shows as:
```suggestion
   class SBFrame(builtins.object)
```

https://github.com/llvm/llvm-project/pull/158331