meson/docs
Dudemanguy 9be6e653d4 find_program: add a kwarg to specify custom version argument
When trying to get the version of a program, meson was previously
hardcoded to run the binary with `--version`. This does work with the
vast majority of programs, but there are a few outliers (e.g. ffmpeg)
which have an unusual argument for printing out the version. Support
these programs by introducing a version_argument kwarg in find_program
which allows users to override `--version` with whatever the custom
argument for printing the version may be for the program.
2024-06-23 15:10:42 +03:00
..
extensions Fix typos in docs 2022-10-23 03:06:39 +03:00
markdown find_program: add a kwarg to specify custom version argument 2024-06-23 15:10:42 +03:00
refman Use SPDX-License-Identifier consistently 2023-12-13 15:19:21 -05:00
theme/extra modules/wayland: Add unstable_wayland module 2022-02-27 14:33:33 -05:00
yaml find_program: add a kwarg to specify custom version argument 2024-06-23 15:10:42 +03: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 Use SPDX-License-Identifier consistently 2023-12-13 15:19:21 -05:00
genrelnotes.py Use SPDX-License-Identifier consistently 2023-12-13 15:19:21 -05:00
jsonvalidator.py Use SPDX-License-Identifier consistently 2023-12-13 15:19:21 -05: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.4.0. 2024-03-13 21:44:41 +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.

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