Migration to gi-docgen

migration-to-gi-docgen.txt

# gi-docgenについて

2022/02/19
坂本 貴史

* 概要
    * 2021年にGNOMEプロジェクトの標準ドキュメンテーションツールが変わりました
    * gtkdocからgi-docgenへ

* gtkdoc
    * https://wiki.gnome.org/DocumentationProject/GtkDoc
    * Cライブラリ向け汎用ドキュメンテーションユーティリティ
    * Perlスクリプトとxsltを使用したドキュメント生成フレームワーク
    * GNOMEプロジェクトの標準ツールだった

 * gtkdoc利用方法
    * GNU Autotools
    * Meson buildのgnome.gtkdoc()
       * https://mesonbuild.com/Gnome-module.html#gnomegtkdoc

 * gi-docgen
    * https://gitlab.gnome.org/GNOME/gi-docgen
    * 2021年にGNOMEプロジェクト標準となったドキュメント生成ツール
    * Gtk3/Gtk4はもうこっちにスイッチ

 * gi-docgenの特徴
    * https://www.bassi.io/articles/2021/02/19/documentation-changes/
    * gobject introspectionによって生成されたライブラリのメタデータを利用
    * ほぼPython 3で書かれている
    
 * gi-docgenの使い方
    * https://gnome.pages.gitlab.gnome.org/gi-docgen/tutorial.html
    * Meson buildのsubprojectsを利用
       * https://mesonbuild.com/Subprojects.html
    * XMLの代わりにMarkdownが(どの方言かわからないけど)使える
    * ドキュメント生成の詳細設定はToMLで与える

 * debianでのパッケージングについて
    * gi-docgenはもうdebパッケージがある
       * https://packages.debian.org/unstable/gi-docgen
    * 依存関係に書いておけばよさそう
       * Meson buildのsubprojectsが、インストールされたgi-docgenが検出できない場合に、ダウンロードしちゃう

 終わり