[libc-commits] [libc] [libc][docs] Furo theme, new landing page, cleanups (PR #184303)

[Jeff Bailey via libc-commits]

================
@@ -0,0 +1,118 @@
+.. _building_docs:
+
+==========================
+Building the Documentation
+==========================
+
+This page explains how to build the LLVM-libc HTML documentation locally so
+you can preview changes before submitting a patch.
+
+Prerequisites
+=============
+
+The LLVM documentation build uses `Sphinx <https://www.sphinx-doc.org/>`__.
+The key packages required are:
+
+* ``sphinx`` — the documentation generator
+* ``furo`` — the theme used by LLVM-libc
+* ``myst-parser`` — Markdown support alongside RST
+* ``sphinx-reredirects`` — handles page redirect entries in ``conf.py``
+
+**On Debian/Ubuntu**, all required packages are available via apt:
+
+.. code-block:: bash
+
+   sudo apt-get install python3-sphinx python3-myst-parser \
+     python3-sphinx-reredirects furo
+
+**On other systems**, install everything from the shared requirements file:
+
+.. code-block:: bash
+
+   pip install -r llvm/docs/requirements.txt
+
+CMake Configuration
+===================
+
+Enable the Sphinx documentation build by adding these flags to your CMake
+invocation:
+
+.. code-block:: bash
+
+   cmake ../llvm \
+     -DLLVM_ENABLE_PROJECTS="libc" \
+     -DLLVM_ENABLE_SPHINX=ON \
+     -DSPHINX_WARNINGS_AS_ERRORS=OFF \
+     -DLIBC_INCLUDE_DOCS=ON \
----------------
kaladron wrote:

I quickly updated that while I'm waiting for the approvals from the others.  Thanks for the catch! =)

https://github.com/llvm/llvm-project/pull/184303