diff options
| author | Thibault Saunier <tsaunier@igalia.com> | 2018-08-17 20:13:08 -0300 |
|---|---|---|
| committer | Thibault Saunier <tsaunier@igalia.com> | 2018-08-28 18:18:40 -0300 |
| commit | 1ea743a0bfd5ab3ab74009fdd0fb2db64e8e79d8 (patch) | |
| tree | 176c6d23d7729337a16828066b4d6c68c1d37fcb /docs/markdown/snippets | |
| parent | 6f72473b2457ecd449259dc6c283976cea8f0e13 (diff) | |
| download | meson-1ea743a0bfd5ab3ab74009fdd0fb2db64e8e79d8.zip meson-1ea743a0bfd5ab3ab74009fdd0fb2db64e8e79d8.tar.gz meson-1ea743a0bfd5ab3ab74009fdd0fb2db64e8e79d8.tar.bz2 | |
hotdoc: Add documentation
Diffstat (limited to 'docs/markdown/snippets')
| -rw-r--r-- | docs/markdown/snippets/hotdoc_module.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/markdown/snippets/hotdoc_module.md b/docs/markdown/snippets/hotdoc_module.md new file mode 100644 index 0000000..4662ea2 --- /dev/null +++ b/docs/markdown/snippets/hotdoc_module.md @@ -0,0 +1,22 @@ +## Hotdoc module + +A new module has been written to ease generation of [hotdoc](https://hotdoc.github.io/) based +documentation. It supports complex use cases such as hotdoc subprojects (to create documentation +portals) and makes it straight forward to leverage full capabilities of hotdoc. + +Simple usage: + +``` meson +hotdoc = import('hotdoc') + +hotdoc.generate_doc( + 'foobar', + c_smart_index: true, + project_version: '0.1', + sitemap: 'sitemap.txt', + index: 'index.md', + c_sources: ['path/to/file.c'], + languages: ['c'], + install: true, +) +```
\ No newline at end of file |