History

Daniel 36de1c67b6 Update Getting-meson_zh.md Sync with the English version		2025-05-08 08:57:11 -07:00
..
extensions	Fix typos in docs	2022-10-23 03:06:39 +03:00
markdown	Update Getting-meson_zh.md	2025-05-08 08:57:11 -07:00
refman	Docs: Cleaner admonishment styling	2025-04-03 00:19:37 +03:00
theme/extra	Docs: Set note/warning title color to black text	2025-04-03 16:59:15 -04:00
yaml	android: Added android_exe_type kwargs to executable	2025-04-17 19:01:22 +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: do not require aiohttp to build	2025-01-20 10:01:00 -05:00
meson_options.txt	docs: add option to skip building HTML docs	2023-05-09 21:33:32 -04:00
sitemap.txt	Add release notes for 1.8 that I forgot.	2025-04-28 20:33:51 +03:00
validatelinks.py	docs: Add a test to validate URLs in markdown/Users.md	2025-01-19 20:36:40 +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