History

David Fort ceaebf6bac add support for generating cmake files This new cmake module allows to generate cmake package files. This may ease the porting for cmake projects that are exporting cmake package informations for other depending projects. The module uses as much as possible the templates provided by the cmake installation (and so cmake needs to be installed).		2019-01-17 20:48:28 +02:00
..
markdown	add support for generating cmake files	2019-01-17 20:48:28 +02:00
theme/extra	hotdoc: Add documentation	2018-08-28 18:18:40 -03: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
meson.build	Upgrade to newest hotdoc. [skip ci]	2018-09-13 21:22:30 +03:00
sitemap.txt	add support for generating cmake files	2019-01-17 20:48:28 +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]