History

Lei YU 8d6b474bf6 Add clang-tidy-fix target Add the `clang-tidy-fix` target to apply clang-tidy fixes to the source code. This is done by calling `run-clang-tidy` with `-fix` argument. Add a test case to run `clang-tidy-fix` and verify the file is changed. Signed-off-by: Lei YU <yulei.sh@bytedance.com>		2023-09-25 16:25:01 +03:00
..
extensions	Fix typos in docs	2022-10-23 03:06:39 +03:00
markdown	Add clang-tidy-fix target	2023-09-25 16:25:01 +03:00
refman	docs: refman: add vim syntax file generator	2023-09-07 19:14:03 -04:00
theme/extra	modules/wayland: Add unstable_wayland module	2022-02-27 14:33:33 -05:00
yaml	docs: fix `add_project_link_arguments` documentation	2023-09-19 12:29:31 -07:00
.editorconfig	editorconfig: Use tabs for sitemap.txt [skip ci]	2018-11-08 20:38:39 +02:00
README.md	docs: mention additional python modules needed for building	2023-05-09 21:33:33 -04:00
genrefman.py	docs: Initial reference manual generator	2021-10-03 11:46:34 +02:00
genrelnotes.py	doc: Add date in release notes	2022-12-09 23:38:26 +02:00
jsonvalidator.py	docs: refman: Add `arg_flattening` support	2022-04-07 17:16:26 -04:00
meson.build	docs: mention additional python modules needed for building	2023-05-09 21:33:33 -04:00
meson_options.txt	docs: add option to skip building HTML docs	2023-05-09 21:33:32 -04:00
sitemap.txt	Whoopsie, forgot to create the release notes.	2023-07-17 00:39:44 +03: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.

Our custom hotdoc extensions require:

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

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