Hotdoc-Modul

Dieses Modul stellt Hilfsfunktionen für die Generierung von Dokumentation mit hotdoc bereit.

Hinzugefügt 0.48.0

Verwendung

Um dieses Modul zu verwenden, einfach: hotdoc = import('hotdoc'). Die folgenden Funktionen sind dann als Methoden des Objekts mit dem Namen hotdoc verfügbar. Sie können den Namen hotdoc natürlich durch einen beliebigen anderen ersetzen.

hotdoc.generate_doc()

Generiert Dokumentation mit hotdoc und installiert sie in $prefix/share/doc/html.

Positionsargumente

• project_name: Der Name des hotdoc-Projekts

Schlüsselwortargumente

• sitemap (str oder file) (erforderlich): Die hotdoc-Sitemap-Datei
• index (str oder file) (erforderlich): Speicherort der Indexdatei
• dependencies(build_tgt): Ziele, von denen die Dokumentationsgenerierung abhängt.
• subprojects: Eine Liste von HotdocTarget, die als Unterprojekte für hotdoc zur Dokumentationsgenerierung verwendet werden.
• ... Jedes Argument von hotdoc kann verwendet werden, wobei Bindestriche (-) durch Unterstriche (_) ersetzt werden. Eine vollständige Liste der verfügbaren Parameter finden Sie unter hotdoc help.

Gibt zurück

HotdocTarget: Ein custom_target() mit den folgenden zusätzlichen Methoden

• config_path: Pfad zur generierten hotdoc-Konfigurationsdatei.

hotdoc.has_extensions()

Positionsargumente

• ...: Die zu suchenden hotdoc-Erweiterungsnamen

Keine Schlüsselwortargumente

Gibt zurück: true, wenn alle Erweiterungen gefunden wurden, andernfalls false.

Beispiel

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