Jonas Devlieghere
e43adaea1f
Convert nine short, low-risk RST docs to MyST Markdown as the first
batch of an incremental RST -> Markdown migration. Subsequent batches
will cover the rest.
Verified by building the docs on origin/main and on this branch with
identical sphinx flags and diffing the rendered HTML. Seven of nine
pages are byte-identical.
contributing.html differs in 42 lines, all attributable to `{doc}` xrefs
replacing RST hyperlinks to sibling pages (`reference external` ->
`reference internal`) and CommonMark collapsing two-spaces-after- period
to one.
ondemand.html differs in 26 lines because two bulleted lists that
followed a paragraph with no blank-line separator originally rendered as
literal `- ...` text in both RST and Markdown. The conversion tool
preserved that by emitting `\-`; this patch instead inserts a blank line
so they render as proper `<ul>` lists, fixing a latent doc bug.
Context:
https://discourse.llvm.org/t/rfc-make-myst-markdown-the-llvm-docs-format-rip-rest/
Assisted-by: Claude
30 lines
1.0 KiB
Markdown
30 lines
1.0 KiB
Markdown
# Python Reference
|
|
|
|
The entire LLDB API is available as Python functions through a script bridging
|
|
interface. This means the LLDB API's can be used directly from python either
|
|
interactively or to build python apps that provide debugger features.
|
|
|
|
Additionally, Python can be used as a programmatic interface within the lldb
|
|
command interpreter (we refer to this for brevity as the embedded interpreter).
|
|
Of course, in this context it has full access to the LLDB API - with some
|
|
additional conveniences we will call out in the FAQ.
|
|
|
|
## Python Tutorials
|
|
|
|
The following tutorials and documentation demonstrate various Python capabilities within LLDB:
|
|
|
|
```{toctree}
|
|
:maxdepth: 1
|
|
|
|
tutorials/accessing-documentation
|
|
tutorials/python-embedded-interpreter
|
|
tutorials/script-driven-debugging
|
|
tutorials/breakpoint-triggered-scripts
|
|
tutorials/creating-custom-breakpoints
|
|
tutorials/automating-stepping-logic
|
|
tutorials/writing-custom-commands
|
|
tutorials/implementing-standalone-scripts
|
|
tutorials/custom-frame-recognizers
|
|
tutorials/extending-target-stop-hooks
|
|
```
|