Jussi Pakkanen a6d088ba3d Created release note page for 1.0.0. il y a 1 an
..
extensions fa2585d0b3 Fix typos in docs il y a 1 an
markdown a6d088ba3d Created release note page for 1.0.0. il y a 1 an
refman e85138fcc8 Fix various spelling errors il y a 1 an
theme 5a4177523e modules/wayland: Add unstable_wayland module il y a 2 ans
yaml 9e1baebb23 fix build_target(objects: ...) documentation il y a 1 an
.editorconfig c9e181c10b editorconfig: Use tabs for sitemap.txt [skip ci] il y a 5 ans
README.md 3c66be0c1d don't tell documentation contributors to skip CI il y a 2 ans
genrefman.py ad65a699f9 docs: Initial reference manual generator il y a 3 ans
genrelnotes.py 17c0a7f76a doc: Add date in release notes il y a 1 an
jsonvalidator.py f192ecd1ef docs: refman: Add `arg_flattening` support il y a 2 ans
meson.build c88c1e7dba doc: Generate dev release notes il y a 2 ans
sitemap.txt a6d088ba3d Created release note page for 1.0.0. il y a 1 an

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