meson/docs
John Ericson 9149aaba9c `add_{global,project}_{,link_}arguments`: simply native flag behavior
This further simplifies behavior to match the "build vs host" decision
we did with `c_args` vs `build_c_args`. The rules are now simply:

 - `native: true` affects `native: true` targets

 - `native: false` affects `native: false` targets

 - No native flag is the same as `native: false`

I like this because you don't even have to know what "build" and "host"
mean to understand how it works, and it doesn't depend on whether the
overall build is cross or not.

Fixes #4933
2019-06-27 21:24:50 +03:00
..
markdown `add_{global,project}_{,link_}arguments`: simply native flag behavior 2019-06-27 21:24:50 +03:00
theme/extra docs: Fix link to SourceSet module in the navbar [skip ci] 2019-06-27 09:15:48 -07: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 Generate release notes from snippets automatically. [skip ci] 2019-03-10 18:40:27 +02:00
meson.build Upgrade to newest hotdoc. [skip ci] 2018-09-13 21:22:30 +03:00
sitemap.txt Update things for new release. 2019-06-16 22:03:29 +03:00

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]