Hotdoc 模块

此模块提供辅助函数，用于使用 hotdoc 生成文档。

新增 0.48.0

用法

要使用此模块，只需执行：**hotdoc = import('hotdoc')**。然后，以下函数将作为方法在名为 hotdoc 的对象上可用。当然，您可以用任何其他名称替换 hotdoc。

hotdoc.generate_doc()

使用 hotdoc 生成文档并将其安装到 $prefix/share/doc/html 中。

位置参数

• project_name: hotdoc 项目的名称

关键字参数

• sitemap (str 或 file) (**必需**): hotdoc 站点地图文件
• index (str 或 file) (**必需**): 索引文件的位置
• dependencies(build_tgt): 文档生成依赖的目标。
• subprojects: 用于 hotdoc 生成文档的 HotdocTarget 列表。
• ... 任何 hotdoc 的参数都可以使用，将破折号 (-) 替换为下划线 (_)。有关可用参数的完整列表，请查看 hotdoc help。

返回值

HotdocTarget: 一个带有以下额外方法的 custom_target()

• config_path: 生成的 hotdoc 配置文件路径。

hotdoc.has_extensions()

位置参数

• ...: 要查找的 hotdoc 扩展名

无关键字参数

返回值: 如果找到所有扩展，则返回 true，否则返回 false。

示例

hotdoc = import('hotdoc')

hotdoc.generate_doc('foobar',
  project_version: '0.1',
  sitemap: 'sitemap.txt',
  index: 'index.md',
  c_sources: ['path/to/file.c'],
  c_smart_index: true,
  languages: ['c'],
  install: true,
)