d89ec98b47
Rust has it's own built in unit test format, which is invoked by compiling a rust executable with the `--test` flag to rustc. The tests are then run by simply invoking that binary. They output a custom test format, which this patch adds parsing support for. This means that we can report each subtest in the junit we generate correctly, which should be helpful for orchestration systems like gitlab and jenkins which can parse junit XML. |
||
|---|---|---|
| .. | ||
| markdown | ||
| markdown_dynamic | ||
| theme/extra | ||
| .editorconfig | ||
| README.md | ||
| genrelnotes.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 built_docs
$ ninja -C built_docs/ upload
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]