mirrors
/
mesa
mirror of https://gitlab.freedesktop.org/mesa/mesa
1
0
Fork 0
Code Issues 9 Packages Projects Releases Wiki Activity

docs: document how to build the docs 

Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/26701>
This commit is contained in:
Eric Engestrom 2023-12-14 20:00:34 +00:00 committed by Marge Bot
parent 0463a951ad
commit 05fb2e21f9
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/submittingpatches.rst
View File

@ -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