(building_docs)=
This page explains how to build the LLVM-libc HTML documentation locally so you can preview changes before submitting a patch.
The LLVM documentation build uses Sphinx. The key packages required are:
sphinx — the documentation generatorfuro — the theme used by LLVM-libcmyst-parser — Markdown support alongside RSTsphinx-reredirects — handles page redirect entries in conf.pyOn Debian/Ubuntu, all required packages are available via apt:
sudo apt-get install python3-sphinx python3-myst-parser \ python3-sphinx-reredirects furo
On other systems, install everything from the shared requirements file:
pip install -r llvm/docs/requirements.txt
Enable the Sphinx documentation build by adding these flags to your CMake invocation:
cmake ../runtimes \ -DLLVM_ENABLE_RUNTIMES="libc" \ -DLLVM_ENABLE_SPHINX=ON \ -DLIBC_INCLUDE_DOCS=ON \ ...
The LLVM_ENABLE_SPHINX=ON flag enables Sphinx globally for all LLVM subprojects. LIBC_INCLUDE_DOCS=ON is specific to libc and tells CMake to register the libc doc targets.
Once configured, build the HTML docs with:
ninja docs-libc-html
The output is written to <build-dir>/tools/libc/docs/html/. Open index.html in a browser to view the site.
The per-header implementation status pages under docs/headers/ are not hand-written Markdown. They are generated at build time by libc/utils/docgen/docgen.py, which:
libc/utils/docgen/<header>.yaml.entrypoints.txt files (excluding TODO stubs).libc/include/llvm-libc-macros/ and libc/include/<header>.yaml for macro definitions.If you add a new function and regenerate, these pages update automatically. Do not hand-edit the generated .md files in docs/headers/ — your changes will be overwritten the next time the docs are built.
Extension error: Could not import extension myst_parser : On Debian/Ubuntu: sudo apt-get install python3-myst-parser. Otherwise: pip install -r llvm/docs/requirements.txt.
WARNING: document isn't included in any toctree : A new RST/Markdown file needs a toctree entry. Add it to the appropriate index.rst or its parent toctree.
Extension error: No module named 'sphinx_reredirects' : Same fix: pip install -r llvm/docs/requirements.txt.