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

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