History

Sebastian Ehlert a6318fb861 Add archiver to reference tables Meson allows to set the archiver via the `AR` environment variable and a native / cross file. Only the latter approach seems to be documented. This patch adds the `AR` environment variable to the reference tables next to the compilers.		2024-11-04 20:00:32 -05:00
..
extensions	Fix typos in docs	2022-10-23 03:06:39 +03:00
markdown	Add archiver to reference tables	2024-11-04 20:00:32 -05:00
refman	Fix typos	2024-09-11 15:51:04 -07:00
theme/extra	modules/wayland: Add unstable_wayland module	2022-02-27 14:33:33 -05:00
yaml	Document the .kernel() and .subsystem() methods	2024-10-02 21:10:34 +03:00
.editorconfig	editorconfig: Use tabs for sitemap.txt [skip ci]	2018-11-08 20:38:39 +02:00
README.md	docs: mention additional python modules needed for building	2023-05-09 21:33:33 -04:00
genrefman.py	Use SPDX-License-Identifier consistently	2023-12-13 15:19:21 -05:00
genrelnotes.py	Use SPDX-License-Identifier consistently	2023-12-13 15:19:21 -05:00
jsonvalidator.py	Use SPDX-License-Identifier consistently	2023-12-13 15:19:21 -05:00
meson.build	docs: mention additional python modules needed for building	2023-05-09 21:33:33 -04:00
meson_options.txt	docs: add option to skip building HTML docs	2023-05-09 21:33:32 -04:00
sitemap.txt	Update docs and version number for release.	2024-10-20 21:20:25 +03:00

Meson Documentation

Build dependencies

Meson uses itself and hotdoc for generating documentation.

Minimum required version of hotdoc is 0.8.9.

Instructions on how to install hotdoc are here.

Our custom hotdoc extensions require:

From the Meson repository root dir:

$ cd docs/
$ meson setup built_docs/
$ ninja -C built_docs/

Now you should be able to open the documentation locally

built_docs/Meson documentation-doc/html/index.html

Meson uses the git-upload hotdoc plugin which basically removes the html pages and replaces with the new content.

You can simply run:

$ ninja -C built_docs/ upload