Skip to content

Instantly share code, notes, and snippets.

@takaswie
Created February 19, 2022 07:24
Show Gist options
  • Save takaswie/b0da082c7675e7303eb32ffacd34348a to your computer and use it in GitHub Desktop.
Save takaswie/b0da082c7675e7303eb32ffacd34348a to your computer and use it in GitHub Desktop.
Migration to gi-docgen
# 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が検出できない場合に、ダウンロードしちゃう
終わり
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment