llvm
f70a28f4 - [lldb][docs] Convert resources/ RST docs to Markdown (NFC) (#201442)

Commit
3 days ago
[lldb][docs] Convert resources/ RST docs to Markdown (NFC) (#201442) Convert the ten contributor-facing RST docs under lldb/docs/resources/ to MyST Markdown. This is the second batch of an incremental RST -> Markdown migration. The previous PR (#201256) covered nine small leaf pages. Files: build, dataformatters, debugging, extensions, formatterbytecode, overview, projects, qemu-testing, sbapi, test. Verified by building the docs on origin/main and on this branch with identical sphinx flags and diffing both the warnings and the rendered HTML. After file extension and line numbers are normalized, the warning sets match exactly. Six of the ten pages are byte-identical. The four that differ (dataformatters, projects, sbapi, test) differ only in: - CommonMark collapsing two-spaces-after-period to one. - MyST adding a `myst` CSS class to `<dl>` elements and an `<hr>` separator before footnote sections. - Footnote IDs renamed from auto `id3` to named `footnote-1`. The diff also surfaced two semantic regressions in the conversion, fixed here: - build.md `{ref}` to `Optional Dependencies` did not match the new `(optional-dependencies)=` anchor; updated to use the new label. - test.md and build.md lost cross-reference behavior on single- backtick refs to SB-class names and `lldb`. RST's default role is `any`, so single backticks attempted xrefs; in MyST single backticks are plain code spans. Converted these 14 occurrences to explicit `{any}`...`` syntax. Several `eval-rst` blocks remain in formatterbytecode.md and test.md to preserve grid tables that MyST does not render natively. Context: https://discourse.llvm.org/t/rfc-make-myst-markdown-the-llvm-docs-format-rip-rest/ Assisted-by: Claude
Author
Parents
Loading