meson/docs
Michael Hirsch, Ph.D fb121f6254 fs: rename samefile => is_samepath
is_samepath better reflects the nature of this function--that files
and directories can be compared.

Also, instead of raising exceptions, simply return False when one
or both .is_samepath(path1, path1) don't exist. This is more
intuitive behavior and avoids having an extra if fs.exist() to go
with every fs.is_samepath()
2019-12-19 08:51:31 -05:00
..
markdown fs: rename samefile => is_samepath 2019-12-19 08:51:31 -05:00
theme/extra docs: Fix link to SourceSet module in the navbar [skip ci] 2019-06-27 09:15:48 -07: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 Update Python2 syntax to Python3 syntax in genrelnotes.py 2019-12-06 15:24:44 +02:00
meson.build Upgrade to newest hotdoc. [skip ci] 2018-09-13 21:22:30 +03:00
sitemap.txt Created the filesystem module. 2019-11-08 00:44:45 +02: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]