mirror-llvm-project/lldb/docs/python_api.md
Jonas Devlieghere e43adaea1f
[lldb][docs] Convert simple RST pages to Markdown (NFC) (#201256)
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
2026-06-03 11:08:56 -07:00

390 B

LLDB Python API

% The long list of "skip" filters out several global functions that are % generated by SWIG (but which are not useful as they are only the % backend for their respective static functions in the classes).

.. automodapi:: lldb
  :no-inheritance-diagram:
  :skip: command
  :skip: declaration
  :skip: in_range
  :skip: is_numeric_type
  :skip: lldb_iter