History

Eli Schwartz 4f05f877fc docs: make note of the path restriction on subdir() It's mentioned in the error message if you try to do it, that you cannot use `..`, but it is probably useful to mention this in the online docs too.		2022-08-29 12:09:52 -04:00
..
extensions	docs: make the refman linkification slightly prettier for codeblocks	2022-06-27 17:07:33 +02:00
markdown	docs: mention in the native-file docs, the command line argument to use	2022-08-29 12:09:52 -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: make note of the path restriction on subdir()	2022-08-29 12:09:52 -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	Finalize the release.	2022-07-03 17:39:59 +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.

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