Revamp the documentation to modernize and uniformize accross components

- Also fixes some autohells deprecations

4 files changed, 23 insertions, 78 deletions

diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 1ea7c47..45647ef 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1,7 +1,5 @@
 ## Process this file with automake to produce Makefile.in
 
-AUTOMAKE_OPTIONS = 1.8
-
 # The name of the module.
 DOC_MODULE=xfconf
 
@@ -12,76 +10,39 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
 SCAN_OPTIONS=--deprecated-guards="XFCONF_DISABLE_DEPRECATED"
 
 # The directory containing the source code. Relative to $(srcdir)
-DOC_SOURCE_DIR=../..
+DOC_SOURCE_DIR=$(top_srcdir)
 
 # Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--xml-mode --output-format=xml
 
 # Extra options to supply to gtkdoc-fixref
-FIXXREF_OPTIONS=--module=$(DOC_MODULE)
+FIXXREF_OPTIONS=
 
 # Used for dependencies
-HFILE_GLOB = \
-	$(top_srcdir)/xfconf/*.h \
-	$(top_srcdir)/xfconfd/*.h
-CFILE_GLOB = \
-	$(top_srcdir)/xfconf/*.c \
-	$(top_srcdir)/xfconfd/*.c \
-	$(top_srcdir)/common/xfconf-errors.c
+HFILE_GLOB =
+CFILE_GLOB =
 
 # Header files to ignore when scanning
-IGNORE_HFILES= \
-	config.h \
-	xfconf-backend-factory.h \
-	xfconf-backend-perchannel-xml.h \
-	xfconf-daemon.h \
-	xfconf-gdbus-bindings.h \
-	xfconf-gdbus-bindings.c \
-	xfconf-marshal.h \
-	xfconf-private.h \
-	xfconf-common-private.h
+IGNORE_HFILES=
 
 # Extra files to add when scanning (relative to $srcdir)
-EXTRA_HFILES=
+EXTRA_HFILES =
 
 # Images to copy into HTML directory
 HTML_IMAGES = 
 
 # Extra SGML files that are included by DOC_MAIN_SGML_FILE
-content_files = \
-	version.xml
+content_files =
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed
 # if $(DOC_MODULE).types is non-empty.
-AM_CPPFLAGS = \
-	-I$(top_srcdir) \
-	-I$(top_builddir) \
-	$(GLIB_CFLAGS) \
-	$(LIBXFCE4UTIL_CFLAGS) \
-	$(GIO_UNIX_CFLAGS) \
-	$(GTK_DOC_EXTRA_CFLAGS)
+GTKDOC_CFLAGS = \
+       -I$(top_srcdir) \
+       -I$(top_builddir)
 
 GTKDOC_LIBS = \
-	$(top_builddir)/xfconf/libxfconf-$(LIBXFCONF_VERSION_API).la \
-	$(top_builddir)/xfconfd/xfconfd-xfconf-backend.o \
-	$(GLIB_LIBS) \
-	$(GOBJECT_LIBS)
+       $(top_builddir)/xfconf/libxfconf-$(LIBXFCONF_VERSION_API).la
 
 include $(top_srcdir)/gtk-doc.make
 
-# Other files to distribute
-EXTRA_DIST += \
-	version.xml.in
-
-# manual pages
-man_MANS =
-
-if MAINTAINER_MODE
-%.1: %.xml
-	xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
-endif
-
-# required for gtk-doc
-dist-hook: all
-
 # vi:set ts=8 sw=8 noet ai nocindent syntax=automake:
diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in
deleted file mode 100644
index d78bda9..0000000
--- a/docs/reference/version.xml.in
+++ /dev/null
@@ -1 +0,0 @@
-@VERSION@
diff --git a/docs/reference/xfconf-docs.xml b/docs/reference/xfconf-docs.xml
index bcecd23..d9311a5 100644
--- a/docs/reference/xfconf-docs.xml
+++ b/docs/reference/xfconf-docs.xml
@@ -3,29 +3,22 @@
                "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 % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
+  %gtkdocentities;
 ]>
 
-<book id="index" lang="en">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
-    <title>Xfconf Reference Manual</title>
-    <releaseinfo>Version <xi:include href="version.xml" parse="text"/></releaseinfo>
-    <pubdate>2017</pubdate>
-
+    <title>&package_name; Reference Manual</title>
+    <releaseinfo>
+      For &package_string;.
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="https://developer.xfce.org/&package_name;/index.html">https://developer.xfce.org/&package_name;/</ulink>.
+    </releaseinfo>
     <copyright>
-      <year>2017</year>
+      <year>2021</year>
       <holder>The Xfce Development Team</holder>
     </copyright>
-
-    <legalnotice id="legalnotice">
-      <para>
-        Permission is granted to copy, distribute and/or modify this document
-        under the terms of the GNU Free Documentation License, Version 1.1 or
-        any later version published by the Free Software Foundation; with no
-        Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
-        Texts. The complete license text is available from the <ulink
-        type="http" url="http://www.gnu.org/">Free Software Foundation</ulink>.
-      </para>
-    </legalnotice>
   </bookinfo>
 
   <chapter>
@@ -51,22 +44,19 @@
 
     <index id="api-index-full">
       <title>All symbols</title>
-      <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-4.5.91">
       <title>Added in 4.5.91</title>
-      <xi:include href="xml/api-index-4.5.91.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-4.5.92">
       <title>Added in 4.5.92</title>
-      <xi:include href="xml/api-index-4.5.92.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-4.12.1">
       <title>Added in 4.12.1</title>
-      <xi:include href="xml/api-index-4.12.1.xml"><xi:fallback /></xi:include>
     </index>
   </chapter>
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 </book>
diff --git a/docs/reference/xfconf.types b/docs/reference/xfconf.types
deleted file mode 100644
index 2ebb559..0000000
--- a/docs/reference/xfconf.types
+++ /dev/null
@@ -1,5 +0,0 @@
-#include <xfconf/xfconf.h>
-#include <xfconfd/xfconf-backend.h>
-
-xfconf_channel_get_type
-xfconf_backend_get_type