meson/docs
Eli Schwartz fae24d86f5
docs: clarify prog.full_path even more
The previous description update was lacking an example of why
external_program cares about inter-target dependencies.
2022-11-30 20:19:56 -05:00
..
extensions Fix typos in docs 2022-10-23 03:06:39 +03:00
markdown Add warning_level=everything 2022-11-27 16:50:48 -05:00
refman Fix various spelling errors 2022-11-24 15:17:23 -05:00
theme/extra modules/wayland: Add unstable_wayland module 2022-02-27 14:33:33 -05:00
yaml docs: clarify prog.full_path even more 2022-11-30 20:19:56 -05: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 genrelnotes: Jump to version 1.0.0 2022-11-09 17:20:41 +02: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 Generate release notes for 0.64. 2022-11-06 15:42:05 +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