fdo-mirrors/mesa
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/mesa/mesa.git synced 2025-12-20 07:20:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: Give more reproducible instructions for how to build the docs.
Some checks are pending
macOS-CI / macOS-CI (dri) (push) Waiting to run
Details
macOS-CI / macOS-CI (xlib) (push) Waiting to run
Details

Browse source 
I routinely don't update the docs because the build (hawkmoth in
particular) is a pain.  The prior instructions almost worked, except that
on Debian you need to use a venv (which is a good idea to do for py3-clang
as well for reproducibility, anyway), and the versions that were listed
didn't actually run any more due to a revoked dependency.

Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/38266>
This commit is contained in:
Emma Anholt 2025-11-05 09:10:59 -08:00 • committed by Marge Bot
parent 4909af6bae
commit 31a4a5ee8c
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/submittingpatches.rst
View file

@ -497,11 +497,12 @@ Our documentation is written as `reStructuredText`_ files in the
.. code-block:: sh .. code-block:: sh
# Install dependencies (adapt for your distribution) # Install dependencies (adapt for your distribution)
apk add coreutils graphviz py3-clang clang-dev musl-dev linux-headers apk add coreutils graphviz clang-dev musl-dev linux-headers
pip3 install sphinx===5.1.1 mako===1.2.3 hawkmoth===0.16.0 python3 -m venv docs-build
./docs-build/bin/pip3 install sphinx===8.2.3 mako===1.2.3 hawkmoth===0.19.0 clang===$(llvm-config --version)
# Build docs # Build docs (on Debian, set LD_LIBRARY_PATH to /usr/lib/llvm-VERSION/lib so it can find libclang.so)
sphinx-build -W -b html docs docs-html/ ./docs-build/bin/sphinx-build -W -b html docs docs-html/
The preferred language of the documentation is US English. This The preferred language of the documentation is US English. This
doesn't mean that everyone is expected to pay close attention to doesn't mean that everyone is expected to pay close attention to