mirror of
https://github.com/mesonbuild/meson.git
synced 2026-08-13 17:07:04 +00:00
69131e7242
It saves bandwidth and disk usage on downloaded subprojects, and people very rarely need more than the single commit they’re using. Add `depth=1` to the `[wrap-git]` examples in the rest of the documentation, to make it more likely that people will copy-and-paste it into their `.wrap` files. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
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