meson/docs
Dylan Baker c5b16ab8b9 modules/rust: Add a machine file property for extra clang args with bindgen
It's currently impossible to inject extra clang arguments when using
bindgen, which is problematic when cross compiling since you may need
critical arguments like `--target=...`. Because such arguments must be
passed after the `--` it's impossible to inject them currently without
going to something like a wrapper script.

Fixes: #11805
2023-06-27 11:53:18 -07:00
..
extensions Fix typos in docs 2022-10-23 03:06:39 +03:00
markdown modules/rust: Add a machine file property for extra clang args with bindgen 2023-06-27 11:53:18 -07:00
refman mlog: use a hidden class for state 2023-05-31 17:20:44 -04:00
theme/extra modules/wayland: Add unstable_wayland module 2022-02-27 14:33:33 -05:00
yaml Added a little more useful info to 'link_whole' documentation, describing the use of /LINKWHOLE with MSVC and the behaviour of re-exporting symbols of individual objects in a static library. 2023-06-27 20:22:11 +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 docs: Initial reference manual generator 2021-10-03 11:46:34 +02:00
genrelnotes.py doc: Add date in release notes 2022-12-09 23:38:26 +02:00
jsonvalidator.py docs: refman: Add `arg_flattening` support 2022-04-07 17:16:26 -04: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.1.0. 2023-04-10 18:39:03 +03: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