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.
 
 
 
 
 
 
Eli Schwartz 8b573d7dc6
i18n.merge_file: do not disable in the absence of gettext tools
3 years ago
..
extensions
markdown i18n.merge_file: do not disable in the absence of gettext tools 3 years ago
refman doc: fix regression that deleted all methods from the reference manual 3 years ago
theme/extra modules/wayland: Add unstable_wayland module 3 years ago
yaml document and raise an error for disallowed combination of install_headers args 3 years ago
.editorconfig
README.md docs: fix bad advice in the README 3 years ago
genrefman.py
genrelnotes.py
jsonvalidator.py
meson.build
sitemap.txt modules/wayland: Add unstable_wayland module 3 years 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 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

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]