2bcc204a11
It makes no sense to specify both: - install_dir, which overrides the -Dincludedir= builtin option - subdir, which suffixes the -Dincludedir= builtin option We've always silently ignored the subdir in this case, which is really surprising if someone actually passed it and expected it to do something. We also confusingly didn't say anything in the documentation about it. Document that the options are incompatible, and explicitly check to see if they are both passed -- if so, raise an error message pointing out that only install_dir should be used. Fixes #10046 |
||
|---|---|---|
| .. | ||
| 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]