meson/docs
Pete Dietl a912193fd8 Fix spelling and grammar in Dependencies.md 2023-04-11 12:44:16 +03:00
..
extensions Fix typos in docs 2022-10-23 03:06:39 +03:00
markdown Fix spelling and grammar in Dependencies.md 2023-04-11 12:44:16 +03:00
refman doc: Use better name for builtin/return object title 2023-03-28 14:56:47 -04:00
theme/extra modules/wayland: Add unstable_wayland module 2022-02-27 14:33:33 -05:00
yaml doc: Fix some broken links 2023-03-28 21:46:32 +03:00
.editorconfig
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 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 doc: Generate dev release notes 2022-05-24 20:19:46 +03: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.

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