![]() This works with pkg-config and cmake without any special support. The custom factory adds further support for config-tool, via `pybind11-config`. This is useful because the config-tool will work out of the box when pybind11 is installed, but the pkg-config and cmake files are shoved into python's site-packages, which is an unfortunate distribution model and makes it impossible to use in an out of the box manner. It's possible to manually set up the PKG_CONFIG_PATH to detect it anyway, but in case that does not happen, having the config-tool fallback is extremely useful. |
||
---|---|---|
.. | ||
extensions | ||
markdown | ||
refman | ||
theme/extra | ||
yaml | ||
.editorconfig | ||
README.md | ||
genrefman.py | ||
genrelnotes.py | ||
jsonvalidator.py | ||
meson.build | ||
sitemap.txt |
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.
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