meson/docs
Alexander Lyashuk cdc6c866ca
doc: update syntax description of immutability
"Stored by value" is more correct way to explain that example.

Mutable vs immutable means that you cannot mutate the value (e.g. list vs tuple in Python), and the example shows that `var2` is actually mutable.

Copying/storing a reference vs value is what what matters in the assignment, in Python `a=b` means `a` and `b` are references to the same list, while in meson `a=b` copies the value of `b` into `a`.
2021-04-28 00:39:56 -04:00
..
markdown doc: update syntax description of immutability 2021-04-28 00:39:56 -04:00
theme/extra doc: Add External Project into the top dropdown menu 2021-03-10 18:31:44 +02:00
.editorconfig editorconfig: Use tabs for sitemap.txt [skip ci] 2018-11-08 20:38:39 +02:00
README.md Update Meson docs README [skip ci] 2018-09-27 01:43:22 -07:00
genrelnotes.py mass rewrite of string formatting to use f-strings everywhere 2021-03-04 17:16:11 -05:00
meson.build Hotdoc: use template for Commands.md instead of generating the entire file (#8154) 2021-01-10 14:48:34 +02:00
sitemap.txt Adding translation to ptbr for getting meson. [skip ci] 2021-04-13 22:33:27 +03:00

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]