diff options
Diffstat (limited to 'docs/markdown/snippets/hotdoc_module.md')
| -rw-r--r-- | docs/markdown/snippets/hotdoc_module.md | 22 |
1 files changed, 0 insertions, 22 deletions
diff --git a/docs/markdown/snippets/hotdoc_module.md b/docs/markdown/snippets/hotdoc_module.md deleted file mode 100644 index 4662ea22b..000000000 --- a/docs/markdown/snippets/hotdoc_module.md +++ /dev/null @@ -1,22 +0,0 @@ -## 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 |