History

Emil Melnikov 141100e482 Add note about meson-python and installation path New people that want to use Meson for building Python extensions most probably will read Python module docs first. Direct them to meson-python and suggest to set `python.install_env=auto`.		2024-06-10 18:12:56 -04:00
..
extensions	Fix typos in docs	2022-10-23 03:06:39 +03:00
markdown	Add note about meson-python and installation path	2024-06-10 18:12:56 -04:00
refman	Use SPDX-License-Identifier consistently	2023-12-13 15:19:21 -05:00
theme/extra	modules/wayland: Add unstable_wayland module	2022-02-27 14:33:33 -05:00
yaml	implement @PLAINNAME0@ and @BASENAME0@	2024-05-09 12:27:35 -07: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	Generate relnotes for 1.4.0.	2024-03-13 21:44:41 +02: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