diff options
author | Christian Persch <chpe@src.gnome.org> | 2022-05-03 21:57:58 +0200 |
---|---|---|
committer | Christian Persch <chpe@src.gnome.org> | 2022-05-03 22:06:46 +0200 |
commit | 4628822dbc45be6444fb11719bc955a630f5fbb1 (patch) | |
tree | 07e6e539d940b586e61fe05ecf9cbafb56d4a678 | |
parent | 0f7a2ff5b87a40b28f3c340a40ed9ff7ecad459b (diff) | |
download | vte-4628822dbc45be6444fb11719bc955a630f5fbb1.tar.gz |
docs: Port to gi-docgen
This greatly simplifies building the documentation for both vte/gtk3 and
vte/gtk4.
-rw-r--r-- | doc/reference/vte-gtk3.toml.in | 54 | ||||
-rw-r--r-- | doc/reference/vte-gtk4.toml.in | 59 |
2 files changed, 113 insertions, 0 deletions
diff --git a/doc/reference/vte-gtk3.toml.in b/doc/reference/vte-gtk3.toml.in new file mode 100644 index 00000000..aa453f63 --- /dev/null +++ b/doc/reference/vte-gtk3.toml.in @@ -0,0 +1,54 @@ +# Copyright © 2022 Christian Persch +# +# This library is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published +# by the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with this library. If not, see <https://www.gnu.org/licenses/>. + +[library] +authors = "VTE developers" +browse_url = "https://gitlab.gnome.org/GNOME/vte/" +dependencies = ["Gdk-3.0", "Gtk-3.0", "GObject-2.0", "Pango-1.0"] +description = "Virtual TErminal widget" +devhelp = true +license = "LGPL-3.0-or-later" +repository_url = "https://gitlab.gnome.org/GNOME/vte.git" +search_index = true +version = "@version@" +website_url = "https://wiki.gnome.org/Apps/Terminal" + + [dependencies."Gdk-3.0"] + description = "The GDK 3.0 toolkit" + docs_url = "https://docs.gtk.org/gdk3/" + name = "GDK" + + [dependencies."Gtk-3.0"] + description = "The GTK+ 3.0 toolkit" + docs_url = "https://docs.gtk.org/gtk3/" + name = "GTK" + + [dependencies."GObject-2.0"] + description = "The GObject 2.0 toolkit" + docs_url = "https://docs.gtk.org/gobject/" + name = "GObject" + + [dependencies."Pango-1.0"] + description = "The Pango 1.0 toolkit" + docs_url = "https://docs.gtk.org/Pango/" + name = "Pango" + +[theme] +name = "basic" +show_class_hierarchy = true +show_index_summary = true + +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/vte/-/blob/master/" diff --git a/doc/reference/vte-gtk4.toml.in b/doc/reference/vte-gtk4.toml.in new file mode 100644 index 00000000..65027e8c --- /dev/null +++ b/doc/reference/vte-gtk4.toml.in @@ -0,0 +1,59 @@ +# Copyright © 2022 Christian Persch +# +# This library is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published +# by the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with this library. If not, see <https://www.gnu.org/licenses/>. + +[library] +authors = "VTE developers" +browse_url = "https://gitlab.gnome.org/GNOME/vte/" +dependencies = ["Gdk-4.0", "Graphene-1.0", "Gtk-4.0", "GObject-2.0", "Pango-1.0"] +description = "Virtual TErminal widget" +devhelp = true +license = "LGPL-3.0-or-later" +repository_url = "https://gitlab.gnome.org/GNOME/vte.git" +search_index = true +version = "@version@" +website_url = "https://wiki.gnome.org/Apps/Terminal" + + [dependencies."Gdk-4.0"] + description = "The GDK 4.0 toolkit" + docs_url = "https://docs.gtk.org/gdk4/" + name = "GDK" + + [dependencies."Graphene-1.0"] + description = "The GSK 1.0 toolkit" + docs_url = "https://ebassi.github.io/graphene/docs/" + name = "Graphene" + + [dependencies."Gtk-4.0"] + description = "The GTK+ 4.0 toolkit" + docs_url = "https://docs.gtk.org/gtk4/" + name = "GTK" + + [dependencies."GObject-2.0"] + description = "The GObject 2.0 toolkit" + docs_url = "https://docs.gtk.org/gobject/" + name = "GObject" + + [dependencies."Pango-1.0"] + description = "The Pango 1.0 toolkit" + docs_url = "https://docs.gtk.org/Pango/" + name = "Pango" + +[theme] +name = "basic" +show_class_hierarchy = true +show_index_summary = true + +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/vte/-/blob/master/" |