History

Jussi Pakkanen 9e1dc30f1f Add CppNorth talk.		2023-06-25 16:27:42 +03:00
..
extensions	Fix typos in docs	2022-10-23 03:06:39 +03:00
markdown	Add CppNorth talk.	2023-06-25 16:27:42 +03:00
refman	mlog: use a hidden class for state	2023-05-31 17:20:44 -04:00
theme/extra	modules/wayland: Add unstable_wayland module	2022-02-27 14:33:33 -05:00
yaml	Clarify `environment` docs.	2023-06-21 08:45:47 -04:00
.editorconfig	…
README.md	docs: mention additional python modules needed for building	2023-05-09 21:33:33 -04:00
genrefman.py	…
genrelnotes.py	doc: Add date in release notes	2022-12-09 23:38:26 +02:00
jsonvalidator.py	docs: refman: Add `arg_flattening` support	2022-04-07 17:16:26 -04: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.1.0.	2023-04-10 18:39:03 +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