78945fb983
The default behavior of installing relative to prefix may be unexpected, and is definitely wrong in many cases. Give users control in order to specify that yes, they actually want to install to a venv. This is particularly useful for projects that use meson as a build system for a python module, where *all* files shall be installed into the python site-packages. |
||
|---|---|---|
| .. | ||
| 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
Contributing to the documentation
Commits that only change documentation should have [skip ci] in their commit message, so CI is not run (it is quite slow).
For example:
A commit message [skip ci]