diff options
author | Gary Kramlich <grim@reaperworld.com> | 2021-10-19 00:48:05 -0500 |
---|---|---|
committer | Gary Kramlich <grim@reaperworld.com> | 2021-10-19 00:48:05 -0500 |
commit | 1493a25aa3dbfccc166c0e80a58483a976dddfc3 (patch) | |
tree | fb4db49e21f8fa5c607b1ae25c3e4d16fcdb235d /doc | |
parent | cd80d0b6d2320f0424e7d0870f6e31035dafcc0a (diff) | |
download | pidgin-1493a25aa3dbfccc166c0e80a58483a976dddfc3.tar.gz |
Convert finch to gi-docgen
Testing Done:
Ran the docs manually and in convey verfied that they look super!
Reviewed at https://reviews.imfreedom.org/r/1072/
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/finch/finch-docs.xml | 60 | ||||
-rw-r--r-- | doc/reference/finch/finch.toml.in | 48 | ||||
-rw-r--r-- | doc/reference/finch/meson.build | 65 | ||||
-rw-r--r-- | doc/reference/finch/urlmap.js | 10 | ||||
-rw-r--r-- | doc/reference/finch/version.xml.in | 1 |
5 files changed, 87 insertions, 97 deletions
diff --git a/doc/reference/finch/finch-docs.xml b/doc/reference/finch/finch-docs.xml deleted file mode 100644 index c25e77b250..0000000000 --- a/doc/reference/finch/finch-docs.xml +++ /dev/null @@ -1,60 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ - -<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -<!ENTITY version SYSTEM "version.xml"> -]> -<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> - <bookinfo> - <title>Finch Reference Manual</title> - <abstract> - <title>Finch &version;</title> - <para> - GNT (GLib Ncurses Toolkit) is an ncurses toolkit for creating text-mode - graphical user interfaces in a fast and easy way. - </para> - <para> - Finch is a text-mode frontend to libpurple, built using libgnt. - </para> - </abstract> - </bookinfo> - - <part id="finch"> - <title>Finch API Reference</title> - - <xi:include href="xml/gntaccount.xml" /> - <xi:include href="xml/gntblist.xml" /> - <xi:include href="xml/gntconn.xml" /> - <xi:include href="xml/gntconv.xml" /> - <xi:include href="xml/gntdebug.xml" /> - <xi:include href="xml/gntxfer.xml" /> - <xi:include href="xml/gntidle.xml" /> - <xi:include href="xml/gntmedia.xml" /> - <xi:include href="xml/gntmenuutil.xml" /> - <xi:include href="xml/gntnotify.xml" /> - <xi:include href="xml/gntplugin.xml" /> - <xi:include href="xml/gntprefs.xml" /> - <xi:include href="xml/gntrequest.xml" /> - <xi:include href="xml/gntroomlist.xml" /> - <xi:include href="xml/gntstatus.xml" /> - <xi:include href="xml/gntui.xml" /> - <xi:include href="xml/finch.xml" /> - </part> - - <part> - <title>Appendices</title> - - <index id="api-index-full"> - <title>API Index</title> - <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> - </index> - - <index id="api-deprecated"> - <title>Index of deprecated symbols</title> - <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> - </index> - - <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> - </part> -</book> diff --git a/doc/reference/finch/finch.toml.in b/doc/reference/finch/finch.toml.in new file mode 100644 index 0000000000..331f588c94 --- /dev/null +++ b/doc/reference/finch/finch.toml.in @@ -0,0 +1,48 @@ +[library] +version = "@PURPLE_VERSION@" +browse_url = "https://keep.imfreedom.org/pidgin/pidgin/" +repository_url = "https://keep.imfreedom.org/pidgin/pidgin/" +website_url = "https://keep.imfreedom.org/pidgin/pidgin/" +authors = "Pidgin Developers" +logo_url = "" +license = "GPL-2.0-or-later" +description = "Finch Universal Chat Client" +dependencies = [ "GLib-2.0", "GObject-2.0", "GModule-2.0", "Gnt-3.0", "Purple-3.0" ] +devhelp = true +search_index = true + + [dependencies."GLib-2.0"] + name = "GLib" + description = "General-purpose, portable utility library." + docs_url = "https://docs.gtk.org/glib/" + + [dependencies."GObject-2.0"] + name = "GObject" + description = "The base type system library" + docs_url = "https://docs.gtk.org/gobject/" + + [dependencies."Gnt-3.0"] + name = "Gnt" + description = "GLib NCurses Toolkit" + docs_url = "https://docs.imfreedom.org/gnt3/" + + [dependencies."Purple-3.0"] + name = "Purple" + description = "Purple Universal Chat Library" + docs_url = "https://docs.imfreedom.org/purple3/" + +[theme] +name = "basic" +show_index_summary = true +show_class_hierarchy = true + +[source-location] +base_url = "https://keep.imfreedom.org/pidgin/pidgin/file/default/" + +[extra] +# The same order will be used when generating the index +content_files = [ +] +content_images = [ +] +urlmap_file = "urlmap.js" diff --git a/doc/reference/finch/meson.build b/doc/reference/finch/meson.build index f97c2afbed..baa6a06d92 100644 --- a/doc/reference/finch/meson.build +++ b/doc/reference/finch/meson.build @@ -1,39 +1,32 @@ -DOC_MODULE = 'finch' +finch_doc_content_files = [] -# Header files or dirs to ignore when scanning. Use base file/dir names -ignore_hfiles = [ - 'plugins', -] +if get_option('doc') + finch_toml = configure_file( + input : 'finch.toml.in', + output : 'finch.toml', + configuration : version_conf, + install : true, + install_dir : docs_dir / 'finch', + ) -# Extra options to supply to gtkdoc-scan. -scan_args = [ - '--deprecated-guards=PURPLE_DISABLE_DEPRECATED|GNT_DISABLE_DEPRECATED|FINCH_DISABLE_DEPRECATED', - '--rebuild-types', - '--rebuild-sections', - '--ignore-headers=' + ' '.join(ignore_hfiles), -] + finch_doc = custom_target('finch-doc', + input : [ finch_toml, libfinch_gir ], + output : 'finch', + command : [ + gidocgen, + 'generate', + '--quiet', + '--fatal-warnings', + '--config=@INPUT0@', + '--output-dir=@OUTPUT@', + '--no-namespace-dir', + '--content-dir=@0@'.format(meson.current_source_dir()), + '@INPUT1@' + ], + depend_files : [ finch_doc_content_files ], + build_by_default : true, + install : true, + install_dir : docs_dir, + ) +endif -# Extra options to supply to gtkdoc-mkdb. -mkdb_args = [ - '--ignore-files=' + ' '.join(ignore_hfiles), -] - -# Extra options to supply to fixxrefs -fixxref_args = [ - '--extra-dir=../libpurple', -] - -configure_file( - input : 'version.xml.in', - output : 'version.xml', - configuration : version_conf) - -finch_doc = gnome.gtkdoc(DOC_MODULE, - main_xml : DOC_MODULE + '-docs.xml', - src_dir : libfinch_inc, - dependencies : libfinch_dep, - install : true, - scan_args : scan_args, - mkdb_args : mkdb_args, - fixxref_args : fixxref_args, - gobject_typesfile : DOC_MODULE + '.types') diff --git a/doc/reference/finch/urlmap.js b/doc/reference/finch/urlmap.js new file mode 100644 index 0000000000..fa6425ba25 --- /dev/null +++ b/doc/reference/finch/urlmap.js @@ -0,0 +1,10 @@ +// SPDX-FileCopyrightText: 2021 GNOME Foundation +// SPDX-License-Identifier: LGPL-2.1-or-later + +// A map between namespaces and base URLs for their online documentation +baseURLs = [ + [ 'GLib', 'https://docs.gtk.org/glib/' ], + [ 'GObject', 'https://docs.gtk.org/gobject/' ], + [ 'Gnt3', 'https://docs.imfreedom.org/gnt3/' ], + [ 'Purple3', 'https://docs.imfreedom.org/purple3/' ], +] diff --git a/doc/reference/finch/version.xml.in b/doc/reference/finch/version.xml.in deleted file mode 100644 index 405528f9af..0000000000 --- a/doc/reference/finch/version.xml.in +++ /dev/null @@ -1 +0,0 @@ -@PURPLE_VERSION@ |