History

Eli Schwartz a864269817 docs: restore build_target method documentation which went missing In the refman rewrite, these functions vanished. I noticed this when I went looking at the docs for extract_all_objects(), or should I say I tried to go looking.		2021-10-07 21:30:55 -04:00
..
extensions	docs: Use a custom hotdoc extension for links to RefMan	2021-10-03 12:19:45 +02:00
markdown	modules/gnome: deprecate yelp variadic sources	2021-10-07 09:26:35 -07:00
refman	docs: Temporarily disable modules and move RefMan --> Reference-manual	2021-10-04 23:11:48 +02:00
theme/extra	Fix syntax error that broke the website	2021-08-22 12:06:18 -04:00
yaml	docs: restore build_target method documentation which went missing	2021-10-07 21:30:55 -04: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
genrefman.py	docs: Initial reference manual generator	2021-10-03 11:46:34 +02:00
genrelnotes.py	fix: Always explicitly set encoding for text files (fixes #8263 )	2021-06-29 11:28:08 +02:00
meson.build	docs: Temporarily disable modules and move RefMan --> Reference-manual	2021-10-04 23:11:48 +02:00
sitemap.txt	docs: Document documenting Meson	2021-10-03 12:19:45 +02:00

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.

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

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

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]