Module: Mesa Branch: main Commit: 05fb2e21f90be6c986e88099773aec3a06a1637e URL: http://cgit.freedesktop.org/mesa/mesa/commit/?id=05fb2e21f90be6c986e88099773aec3a06a1637e
Author: Eric Engestrom <e...@igalia.com> Date: Thu Dec 14 20:00:34 2023 +0000 docs: document how to build the docs Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/26701> --- docs/submittingpatches.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/submittingpatches.rst b/docs/submittingpatches.rst index 4208532c90b..57b880f9546 100644 --- a/docs/submittingpatches.rst +++ b/docs/submittingpatches.rst @@ -409,6 +409,15 @@ Documentation patches Our documentation is written as `reStructuredText`_ files in the :file:`docs` folder, and built using `Sphinx`_. +.. code-block:: sh + + # Install dependencies (adapt for your distro) + apk add coreutils graphviz py3-clang clang-dev musl-dev linux-headers + pip3 install sphinx===5.1.1 mako===1.2.3 hawkmoth===0.16.0 + + # Build docs + sphinx-build -W -b html docs docs-html/ + The preferred language of the documentation is US English. This doesn't mean that everyone is expected to pay close attention to the different English variants, but it does mean someone might
