History

Xavier Claessens b5100fe86a gnome: Add post_install() method Various GNOME projects have scripts that does similar task, better do it directly in meson. This ensures it's done correctly regarding usage of subprojects and pkg-config. See for example this gtk bug: https://gitlab.gnome.org/GNOME/gtk/-/issues/3626. Fixes: #8268		2021-02-05 15:08:47 -05:00
..
markdown	gnome: Add post_install() method	2021-02-05 15:08:47 -05:00
theme/extra	modules: Add an unstable-rust module	2021-01-05 15:10:50 -08:00
.editorconfig	…
README.md	…
genrelnotes.py	Update Python2 syntax to Python3 syntax in genrelnotes.py	2019-12-06 15:24:44 +02:00
meson.build	Hotdoc: use template for Commands.md instead of generating the entire file (#8154 )	2021-01-10 14:48:34 +02:00
sitemap.txt	modules: Add an unstable-rust module	2021-01-05 15:10:50 -08: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.

From the Meson repository root dir:

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

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

Commits that only change documentation should have [skip ci] in their commit message, so CI is not run (it is quite slow). For example:

A commit message [skip ci]