meson/docs
Patrick Steinhardt d3c8639975 mtest: add option to slice tests
Executing tests can take a very long time. As an example, the Git test
suite on Windows takes around 4 hours to execute. The Git project has
been working around the issue by splitting up CI jobs into multiple
slices: one job creates the build artifacts, and then we spawn N test
jobs with those artifacts, where each test job executes 1/Nth of the
tests.

This can be scripted rather easily by using `meson test --list`,
selecting every Nth line, but there may be other projects that have a
similar need. Wire up a new option "--slice i/n" to `meson test` that
does implements this logic.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
2025-02-27 15:25:05 -05:00
..
extensions Fix typos in docs 2022-10-23 03:06:39 +03:00
markdown mtest: add option to slice tests 2025-02-27 15:25:05 -05:00
refman Fix typos 2024-09-11 15:51:04 -07:00
theme/extra modules/wayland: Add unstable_wayland module 2022-02-27 14:33:33 -05:00
yaml allow to compare multiple version with version_compare 2025-01-27 01:27:03 +02: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: do not require aiohttp to build 2025-01-20 10:01:00 -05:00
meson_options.txt docs: add option to skip building HTML docs 2023-05-09 21:33:32 -04:00
sitemap.txt Created release notes for 1.7.0. 2025-01-26 20:02:34 +02:00
validatelinks.py docs: Add a test to validate URLs in markdown/Users.md 2025-01-19 20:36:40 +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