mirror-llvm-project/libunwind/docs
Reid Kleckner 93b1240309
[docs] Finish misc MyST migration (#210209)
Tracking issue: #201242
See the [migration guide] for more information.

[migration guide]:
https://llvm.org/docs/SphinxQuickstartTemplate.html#markdown-migration-guidelines

This is a stacked PR based on #210208, which is the standalone rename
commit for this miscellaneous Markdown migration batch.

This was prepared with rst2myst plus LLM-assisted cleanup. LLDB man
pages are intentionally left as reStructuredText because LLDB man-page
building should not take on Markdown parser dependencies.

Unfortunately, many of these miscellaneous docs do not have working
standalone doc build targets, so I was not able to render HTML for all
of them. I think the scope is small enough that this is reviewable by
hand.
2026-07-17 11:56:59 -07:00
..
BuildingLibunwind.md [docs] Finish misc MyST migration (#210209) 2026-07-17 11:56:59 -07:00
CMakeLists.txt
conf.py [docs] Rename misc rst docs to md (#210208) 2026-07-17 10:48:13 -07:00
index.md [docs] Finish misc MyST migration (#210209) 2026-07-17 11:56:59 -07:00
README.txt

libunwind Documentation
====================

The libunwind documentation is written using the Sphinx documentation generator. It is
currently tested with Sphinx 1.1.3.

To build the documents into html configure libunwind with the following cmake options:

  * -DLLVM_ENABLE_SPHINX=ON
  * -DLIBUNWIND_INCLUDE_DOCS=ON

After configuring libunwind with these options the make rule `docs-libunwind-html`
should be available.