Virtualization
/
meson
mirror of https://gitlab.com/qemu-project/meson.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
meson/docs
History
Eli Schwartz 2afe0a4475
docs: provide details about how to fund Meson development 
At the moment it turns out this mostly means... me. But this was
discussed publicly, as requested by a third party, and as per the newly
added page this is open to anyone in the Project who wishes to let it be
known that they accept donations.

Closes: https://github.com/mesonbuild/meson/issues/14262
 		2025-03-07 10:20:54 -05:00
..
extensions Fix typos in docs 2022-10-23 03:06:39 +03:00
markdown docs: provide details about how to fund Meson development 2025-03-07 10:20:54 -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
…
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