Hotdoc 模組

此模組提供使用 hotdoc 產生文件的輔助函式。

新增於 0.48.0

使用方式

要使用此模組，只需執行：hotdoc = import('hotdoc')。然後，以下函式將以名稱為 hotdoc 的物件上的方法提供。當然，您可以將名稱 hotdoc 替換為任何其他名稱。

hotdoc.generate_doc()

使用 hotdoc 產生文件，並將其安裝到 $prefix/share/doc/html。

位置引數

• project_name：hotdoc 專案的名稱

關鍵字引數

• sitemap ( 字串 或 檔案) (必要)：hotdoc 網站地圖檔案
• index ( 字串 或 檔案) (必要)：索引檔案的位置
• dependencies ( build_tgt)：文件產生所依賴的目標。
• subprojects：一個 HotdocTarget 清單，用於作為 hotdoc 產生文件的子專案。
• ... 可以使用任何 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,
)