History

Tristan Partin b08d531c02 Document that alias_target accepts run_tgts since 0.60.0 This was implemented in `dc51740e2c`, but was not added to the documentation or marked as a new feature.		2024-02-09 11:56:13 -05:00
..
extensions	Fix typos in docs	2022-10-23 03:06:39 +03:00
markdown	Add a numpy dependency with pkg-config and configtool methods	2024-02-06 12:54:35 -08: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	Document that alias_target accepts run_tgts since 0.60.0	2024-02-09 11:56:13 -05: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 release notes for 1.3.0.	2023-11-19 21:58:19 +02: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.

Our custom hotdoc extensions require:

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