The Meson Build System http://mesonbuild.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Eli Schwartz a45446b6e5
minstall: stop running ldconfig for the user
3 years ago
..
extensions docs: Use a custom hotdoc extension for links to RefMan 3 years ago
markdown minstall: stop running ldconfig for the user 3 years ago
refman doc: fix regression that deleted all methods from the reference manual 3 years ago
theme/extra remove the RPM module 3 years ago
yaml docs: find_program can return the current Python3 interpreter 3 years ago
.editorconfig compilers/d: Add b_ndebug support 5 years ago
README.md docs: fix bad advice in the README 3 years ago
genrefman.py docs: Initial reference manual generator 3 years ago
genrelnotes.py fix: Always explicitly set encoding for text files (fixes #8263) 3 years ago
jsonvalidator.py docs: Add a validator for the new JSON docs 3 years ago
meson.build add man page generation to build 3 years ago
sitemap.txt remove the RPM module 3 years ago

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]