Virtualization
/
meson
mirror of https://gitlab.com/qemu-project/meson.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
meson/docs
History
Sam James cf2cda0f3e docs: users: list is for notable meson adoptees 
We don't want churn with thie list for every project someone creates
that uses Meson. Change the intro to say we want notable projects and
link to a GitHub search for 'meson.build' files for people who want
further examples to consider.
 		2025-04-23 00:33:45 +03:00
..
extensions Fix typos in docs 2022-10-23 03:06:39 +03:00
markdown docs: users: list is for notable meson adoptees 2025-04-23 00:33:45 +03:00
refman Docs: Cleaner admonishment styling 2025-04-03 00:19:37 +03:00
theme/extra Docs: Set note/warning title color to black text 2025-04-03 16:59:15 -04:00
yaml android: Added android_exe_type kwargs to executable 2025-04-17 19:01:22 +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: 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 docs: provide details about how to fund Meson development 2025-03-07 10:20:54 -05: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