diff options
Update GTK-Doc master page
-rw-r--r-- | .gitignore | 19 | ||||
-rw-r--r-- | configure.ac | 3 | ||||
-rw-r--r-- | docs/reference/Makefile.am | 40 | ||||
-rw-r--r-- | docs/reference/gnome-autoar-docs.xml | 39 | ||||
-rw-r--r-- | docs/reference/gnome-autoar/Makefile.am | 35 |
5 files changed, 88 insertions, 48 deletions
@@ -46,13 +46,12 @@ tests/test-create tests/test-pref tests/test-ui -docs/reference/gnome-autoar/html -docs/reference/gnome-autoar/xml -docs/reference/gnome-autoar/*.args -docs/reference/gnome-autoar/*.hierarchy -docs/reference/gnome-autoar/*.interfaces -docs/reference/gnome-autoar/*.prerequisites -docs/reference/gnome-autoar/*.signals -docs/reference/gnome-autoar/*.txt -docs/reference/gnome-autoar/*.types -docs/reference/gnome-autoar/gnome-autoar-docs.xml +docs/reference/html +docs/reference/xml +docs/reference/*.args +docs/reference/*.hierarchy +docs/reference/*.interfaces +docs/reference/*.prerequisites +docs/reference/*.signals +docs/reference/*.txt +docs/reference/*.types diff --git a/configure.ac b/configure.ac index 47a64b1..47809e4 100644 --- a/configure.ac +++ b/configure.ac @@ -64,8 +64,7 @@ AC_CONFIG_FILES([Makefile data/Makefile tests/Makefile docs/Makefile - docs/reference/Makefile - docs/reference/gnome-autoar/Makefile]) + docs/reference/Makefile]) AC_OUTPUT echo " diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 41a8d10..4f06d44 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -1 +1,39 @@ -SUBDIRS = gnome-autoar +# vim: set sw=8 ts=8 sts=8 noet: + +NULL = + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +DOC_MODULE=gnome-autoar +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml +MKDB_OPTIONS=--xml-mode --output-format=xml + +DOC_SOURCE_DIR=$(top_srcdir)/gnome-autoar +HFILE_GLOB=$(top_srcdir)/gnome-autoar/*.h +CFILE_GLOB=$(top_srcdir)/gnome-autoar/*.c + +IGNORE_HFILES = \ + autoar.h \ + autoar-enum-types.h \ + $(NULL) + +GTKDOC_CFLAGS = \ + -I$(top_srcdir) \ + -I$(DEPENDENCIES_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS = \ + $(top_builddir)/gnome-autoar/libgnome-autoar.la \ + $(DEPENDENCIES_LIBS) \ + $(NULL) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +if ENABLE_GTK_DOC +TESTS_ENVIRONMENT = cd $(srcdir) && \ + DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ + SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) +#TESTS = $(GTKDOC_CHECK) +endif diff --git a/docs/reference/gnome-autoar-docs.xml b/docs/reference/gnome-autoar-docs.xml new file mode 100644 index 0000000..3420967 --- /dev/null +++ b/docs/reference/gnome-autoar-docs.xml @@ -0,0 +1,39 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<book id="index"> + <bookinfo> + <title>gnome-autoar Reference Manual</title> + </bookinfo> + + <chapter> + <title>gnome-autoar Core</title> + <xi:include href="xml/autoar-create.xml"/> + <xi:include href="xml/autoar-extract.xml"/> + <xi:include href="xml/autoar-pref.xml"/> + </chapter> + <chapter> + <title>gnome-autoar Utilities</title> + <xi:include href="xml/autoar-format-filter.xml"/> + <xi:include href="xml/autoar-gtk.xml"/> + <xi:include href="xml/autoar-common.xml"/> + </chapter> + + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + <index id="deprecated-api-index" role="deprecated"> + <title>Index of deprecated API</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> +</book> diff --git a/docs/reference/gnome-autoar/Makefile.am b/docs/reference/gnome-autoar/Makefile.am deleted file mode 100644 index 0361660..0000000 --- a/docs/reference/gnome-autoar/Makefile.am +++ /dev/null @@ -1,35 +0,0 @@ -# vim: set sw=8 ts=8 sts=8 noet: - -NULL = - -# We require automake 1.6 at least. -AUTOMAKE_OPTIONS = 1.6 - -DOC_MODULE=gnome-autoar -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml -DOC_SOURCE_DIR=$(top_srcdir)/gnome-autoar -MKDB_OPTIONS=--xml-mode --output-format=xml -HFILE_GLOB=$(top_srcdir)/gnome-autoar/*.h -CFILE_GLOB=$(top_srcdir)/gnome-autoar/*.c -IGNORE_HFILES=$(top_srcdir)/gnome-autoar/autoar-enum-types.h -IGNORE_CFILES=$(top_srcdir)/gnome-autoar/autoar-enum-types.c - -GTKDOC_CFLAGS = \ - -I$(top_srcdir) \ - -I$(DEPENDENCIES_CFLAGS) \ - $(NULL) - -GTKDOC_LIBS = \ - $(top_builddir)/gnome-autoar/libgnome-autoar.la \ - $(DEPENDENCIES_LIBS) \ - $(NULL) - -# This includes the standard gtk-doc make rules, copied by gtkdocize. -include $(top_srcdir)/gtk-doc.make - -if ENABLE_GTK_DOC -TESTS_ENVIRONMENT = cd $(srcdir) && \ - DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ - SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) -#TESTS = $(GTKDOC_CHECK) -endif |