meson/docs
Eli Schwartz e99e55d0aa
docs: fix incorrect info for declare_dependency sources
The type information is clearly wrong as it disagrees with the
description w.r.t. generated headers.

We also rely on it accepting custom targets for the obvious reason that
we accept it in a build target too! In fact, we rely on this in the
testsuite too.
2022-06-17 14:33:01 -04:00
..
extensions docs: Use a custom hotdoc extension for links to RefMan 2021-10-03 12:19:45 +02:00
markdown doc: Add meson.override_dependency() in external-project example 2022-06-16 09:18:24 -04:00
refman docs: refman: Add `arg_flattening` support 2022-04-07 17:16:26 -04:00
theme/extra modules/wayland: Add unstable_wayland module 2022-02-27 14:33:33 -05:00
yaml docs: fix incorrect info for declare_dependency sources 2022-06-17 14:33:01 -04:00
.editorconfig editorconfig: Use tabs for sitemap.txt [skip ci] 2018-11-08 20:38:39 +02:00
README.md don't tell documentation contributors to skip CI 2022-05-26 20:47:39 -04:00
genrefman.py docs: Initial reference manual generator 2021-10-03 11:46:34 +02:00
genrelnotes.py docs: ensure stable order of release notes 2022-06-17 06:48:45 -04:00
jsonvalidator.py docs: refman: Add `arg_flattening` support 2022-04-07 17:16:26 -04:00
meson.build doc: Generate dev release notes 2022-05-24 20:19:46 +03:00
sitemap.txt Prepare the 0.62.0 release. 2022-03-21 23:24:01 +02: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 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