History

Xavier Claessens 2fabd4c7dc minstall: Add --skip-subprojects option By default all subprojects are installed. If --skip-subprojects is given with no value only the main project is installed. If --skip-subprojects is given with a value, it should be a coma separated list of subprojects to skip and all others will be installed. Fixes: #2550.		2021-02-22 23:03:55 +02:00
..
markdown	minstall: Add --skip-subprojects option	2021-02-22 23:03:55 +02:00
theme/extra	modules: Add an unstable-rust module	2021-01-05 15:10:50 -08:00
.editorconfig	editorconfig: Use tabs for sitemap.txt [skip ci]	2018-11-08 20:38:39 +02:00
README.md	Update Meson docs README [skip ci]	2018-09-27 01:43:22 -07:00
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	Set up release 0.57.	2021-02-14 21:28:44 +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.

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]