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,
)

検索結果は次のとおりです

GitHubで編集