The Meson Build System http://mesonbuild.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Xavier Claessens ef3992f1cc configure_file(): Allow multiple inputs in command mode 1 week ago
..
markdown configure_file(): Allow multiple inputs in command mode 1 day ago
theme/extra docs: Fix link to SourceSet module in the navbar [skip ci] 2 months ago
.editorconfig editorconfig: Use tabs for sitemap.txt [skip ci] 10 months ago
README.md Update Meson docs README [skip ci] 11 months ago
genrelnotes.py Generate release notes from snippets automatically. [skip ci] 6 months ago
meson.build Upgrade to newest hotdoc. [skip ci] 1 year ago
sitemap.txt Add is_disabler function 1 month ago

README.md

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.

Building the documentation

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

Upload

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

Contributing to the documentation

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]