summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRichard Hughes <richard@hughsie.com>2014-03-12 15:26:45 +0000
committerRichard Hughes <richard@hughsie.com>2014-03-12 15:54:17 +0000
commit32cb5d554937b62f2e6e630afc7cb7dea0c5d725 (patch)
treed6db1b29b7f728dd8c512f68653eba0534d71632 /docs
parentddfeb3ad8df0d41ff015305f07f50a8b4fc9e331 (diff)
downloadappstream-glib-32cb5d554937b62f2e6e630afc7cb7dea0c5d725.tar.gz
Add initial project files
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am5
-rw-r--r--docs/api/Makefile.am85
-rw-r--r--docs/api/appstream-glib-docs.sgml44
-rwxr-xr-xdocs/api/clean.sh7
-rw-r--r--docs/api/version.xml.in1
5 files changed, 142 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..aabe0d2
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,5 @@
+SUBDIRS = \
+ api
+
+
+-include $(top_srcdir)/git.mk
diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am
new file mode 100644
index 0000000..8534642
--- /dev/null
+++ b/docs/api/Makefile.am
@@ -0,0 +1,85 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=appstream-glib
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+DOC_SOURCE_DIR=../../libappstream-glib
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+HFILE_GLOB=$(top_srcdir)/libappstream-glib/as-*.h
+CFILE_GLOB=$(top_srcdir)/libappstream-glib/as-*.c
+
+# Header files to ignore when scanning.
+IGNORE_HFILES = \
+ config.h
+
+# Images to copy into HTML directory.
+#HTML_IMAGES = \
+# spec/pk-transactions-success.png \
+# spec/pk-transactions-trusted.png
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+content_files = \
+ version.xml
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+expand_content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+AM_CPPFLAGS = \
+ $(GLIB_CFLAGS) \
+ -I$(top_builddir)/libappstream-glib \
+ -I$(top_srcdir)/libappstream-glib \
+ $(NULL)
+
+AS_LIBS = $(top_builddir)/libappstream-glib/libappstream-glib.la
+
+GTKDOC_LIBS = \
+ $(GLIB_LIBS) \
+ $(AS_LIBS)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+CLEANFILES += \
+ *.txt \
+ *.types \
+ *.args \
+ *.hierarchy \
+ *.interfaces \
+ *.prerequisites \
+ *.signals \
+ *.stamp \
+ tmpl
+
+# Other files to distribute
+EXTRA_DIST += version.xml.in
+
+-include $(top_srcdir)/git.mk
diff --git a/docs/api/appstream-glib-docs.sgml b/docs/api/appstream-glib-docs.sgml
new file mode 100644
index 0000000..340e7e3
--- /dev/null
+++ b/docs/api/appstream-glib-docs.sgml
@@ -0,0 +1,44 @@
+<?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>AppStream-glib Reference Manual</title>
+ <releaseinfo>
+ for AppStream-glib &version;
+ </releaseinfo>
+ <authorgroup>
+ <author>
+ <firstname>Richard</firstname>
+ <surname>Hughes</surname>
+ <affiliation>
+ <address>
+ <email>richard@hughsie.com</email>
+ </address>
+ </affiliation>
+ </author>
+ </authorgroup>
+ <copyright>
+ <year>2014</year>
+ <holder>Richard Hughes</holder>
+ </copyright>
+ </bookinfo>
+
+ <reference id="libappstream-glib">
+ <title>libappstream-glib GObject library</title>
+ <partintro>
+ <para>
+ This part documents GObjects used in libappstream-glib.
+ </para>
+ </partintro>
+ <xi:include href="xml/as-app.xml"/>
+ </reference>
+
+ <xi:include href="xml/annotation-glossary.xml">
+ <xi:fallback />
+ </xi:include>
+
+</book>
+
diff --git a/docs/api/clean.sh b/docs/api/clean.sh
new file mode 100755
index 0000000..c335583
--- /dev/null
+++ b/docs/api/clean.sh
@@ -0,0 +1,7 @@
+rm -f *.txt
+rm -f *-scan.*
+rm -f *.types
+rm -f html/*
+rm -f tmpl/*
+rm -f xml/*
+
diff --git a/docs/api/version.xml.in b/docs/api/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/docs/api/version.xml.in
@@ -0,0 +1 @@
+@VERSION@