docs: Add D-Bus API reference generation

Closes: intel#244

.gitignore

@@ -38,3 +38,4 @@ thd_dbus_interface.h
 .project
 *thermald.service
 .dirstamp
+version.xml

Makefile.am

@@ -1,6 +1,6 @@
 include $(GLIB_MAKEFILE)
 
-SUBDIRS = data
+SUBDIRS = . docs data
 
 ACLOCAL_AMFLAGS =
 

autogen.sh

@@ -6,7 +6,9 @@ olddir=`pwd`
 
 cd "$srcdir"
 
-autoreconf --install --verbose
+aclocal --install || exit 1
+gtkdocize --copy --flavour no-tmpl || exit 1
+autoreconf --install --verbose || exit 1
 
 cd "$olddir"
 

configure.ac

@@ -8,12 +8,15 @@ m4_define([td_version],
 AC_INIT([thermald], [td_version], [], [thermald])
 m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])])
 
+AC_CONFIG_MACRO_DIR([m4])
 AC_CONFIG_AUX_DIR(build-aux)
 AC_CONFIG_HEADERS([config.h])
 
 AM_INIT_AUTOMAKE([1.11 foreign no-define subdir-objects])
 AM_MAINTAINER_MODE([enable])
 
+GTK_DOC_CHECK([1.11],[--flavour no-tmpl])
+
 AC_ARG_WITH(dbus-sys-dir, AS_HELP_STRING([--with-dbus-sys-dir=DIR], [where D-BUS system.d directory is]))
 if test -n "$with_dbus_sys_dir" ; then
     DBUS_SYS_DIR="$with_dbus_sys_dir"
@@ -71,6 +74,8 @@ AC_SUBST(GLIB_LIBS)
 
 PKG_CHECK_MODULES(XML, libxml-2.0 >= 2.4)
 
+AC_PATH_PROG([GDBUS_CODEGEN],[gdbus-codegen])
+
 AC_PROG_CC
 AC_PROG_CPP
 AC_PROG_CXX
@@ -102,6 +107,8 @@ done
 ], [AC_MSG_ERROR([AX_CHECK_COMPILE_FLAG not found, you'll need to install autoconf-archive])])
 
 AC_CONFIG_FILES([Makefile
+                 docs/Makefile
+                 docs/version.xml
                  data/Makefile])
 
 AC_OUTPUT

docs/Makefile.am

@@ -0,0 +1,60 @@
+NULL =
+
+AUTOMAKE_OPTIONS = 1.7
+
+# The name of the module.
+DOC_MODULE=thermal_daemon
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=thermal_daemon-docs.xml
+
+# Extra options to supply to gtkdoc-scan
+SCAN_OPTIONS= \
+	--ignore-headers="config.h thd*.h thermald.h acpi_*.h" \
+	--rebuild-sections --rebuild-types
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=
+
+# Used for dependencies
+HFILE_GLOB=
+CFILE_GLOB=
+
+# Headers to ignore
+IGNORE_HFILES= \
+	$(NULL)
+
+GTKDOC_LIBS =
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+docs-thd_dbus_interface.xml: $(top_srcdir)/src/thd_dbus_interface.xml
+	$(AM_V_GEN)$(GDBUS_CODEGEN) --generate-docbook=docs $<
+
+# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
+content_files =				\
+	version.xml			\
+	docs-thd_dbus_interface.xml	\
+	$(NULL)
+
+# FIXME
+MAINTAINERCLEANFILES =		\
+	*~			\
+	Makefile.in		\
+	thermal_daemon.types	\
+	thermal_daemon-*.txt	\
+	$(NULL)
+
+include $(top_srcdir)/gtk-doc.make
+
+EXTRA_DIST = thermal_daemon-docs.xml
+
+CLEANFILES +=				\
+	docs-thermal_daemon.xml		\
+	$(NULL)
+
+# Version information for marking the documentation
+EXTRA_DIST += version.xml.in
+
+-include $(top_srcdir)/git.mk

docs/thermal_daemon-docs.xml

@@ -0,0 +1,81 @@
+<?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 version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>Thermal Daemon Reference Manual</title>
+    <releaseinfo>Version &version;</releaseinfo>
+    <authorgroup>
+      <author>
+	<firstname>Bastien</firstname>
+	<surname>Nocera</surname>
+	<affiliation>
+	  <address>
+	    <email>[email protected]</email>
+	  </address>
+	</affiliation>
+      </author>
+    </authorgroup>
+
+    <copyright>
+      <year>2020</year>
+      <holder>Red Hat, Inc.</holder>
+    </copyright>
+
+    <legalnotice>
+      <para>
+	Permission is granted to copy, distribute and/or modify this
+	document under the terms of the <citetitle>GNU Free
+	Documentation License</citetitle>, Version 1.1 or any later
+	version published by the Free Software Foundation with no
+	Invariant Sections, no Front-Cover Texts, and no Back-Cover
+	Texts. You may obtain a copy of the <citetitle>GNU Free
+	Documentation License</citetitle> from the Free Software
+	Foundation by visiting <ulink type="http"
+	url="http://www.fsf.org">their Web site</ulink> or by writing
+	to:
+
+	<address>
+	  The Free Software Foundation, Inc.,
+	  <street>59 Temple Place</street> - Suite 330,
+	  <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
+	  <country>USA</country>
+	</address>
+      </para>
+
+      <para>
+	Many of the names used by companies to distinguish their
+	products and services are claimed as trademarks. Where those
+	names appear in any GNOME documentation, and those trademarks
+	are made aware to the members of the GNOME Documentation
+	Project, the names have been printed in caps or initial caps.
+      </para>
+    </legalnotice>
+  </bookinfo>
+
+  <reference id="ref-dbus">
+    <title>D-Bus API Reference</title>
+    <partintro>
+      <para>
+	This part documents the D-Bus interface used to access the
+	Thermal Daemon service.
+      </para>
+    </partintro>
+    <xi:include href="docs-org.freedesktop.thermald.xml"/>
+  </reference>
+
+  <index>
+    <title>Index</title>
+  </index>
+
+  <!-- License -->
+
+  <appendix id="license">
+    <title>License</title>
+    <para>
+<programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../COPYING" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
+    </para>
+  </appendix>
+</book>

docs/version.xml.in

@@ -0,0 +1 @@
+@VERSION@