meson/docs
Charles Brunet e7b9dfac98 mtest: wildcard selection
Allow the use of wildcards (e.g. *) to match test names in `meson test`.

Raise an error is given test name does not match any test.

Optimize the search by looping through the list of tests only once.
2023-05-25 13:44:13 -04:00
..
extensions Fix typos in docs 2022-10-23 03:06:39 +03:00
markdown mtest: wildcard selection 2023-05-25 13:44:13 -04:00
refman doc: Add link to argument details 2023-05-03 15:06:35 -04:00
theme/extra modules/wayland: Add unstable_wayland module 2022-02-27 14:33:33 -05:00
yaml repair install_mode support for uid/gid effectively everywhere 2023-05-24 19:05:06 -04: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 Generate relnotes for 1.1.0. 2023-04-10 18:39:03 +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.

Our custom hotdoc extensions require:

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