[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [libvirt-designer][PATCH 2/6] Create basic documentation



In fact, it's only bare skeleton for gtkdoc
---
 .gitignore                     |   16 +++++++++++++++
 Makefile.am                    |    2 +-
 configure.ac                   |    1 +
 docs/Makefile.am               |   42 ++++++++++++++++++++++++++++++++++++++++
 docs/libvirt-designer-docs.xml |   27 +++++++++++++++++++++++++
 5 files changed, 87 insertions(+), 1 deletions(-)
 create mode 100644 docs/Makefile.am
 create mode 100644 docs/libvirt-designer-docs.xml

diff --git a/.gitignore b/.gitignore
index d570af8..4272672 100644
--- a/.gitignore
+++ b/.gitignore
@@ -36,3 +36,19 @@ Makefile.in
 /m4/ltversion.m4
 /m4/lt~obsolete.m4
 /stamp-h1
+docs/xml/
+docs/html/
+docs/*.stamp
+docs/*-decl-list.txt
+docs/*-decl.txt
+docs/*-overrides.txt
+docs/*-sections.txt
+docs/*-undeclared.txt
+docs/*-undocumented.txt
+docs/*-unused.txt
+docs/*.args
+docs/*.hierarchy
+docs/*.interfaces
+docs/*.prerequisites
+docs/*.signals
+docs/*.types
diff --git a/Makefile.am b/Makefile.am
index ab06626..f5bcc47 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,5 +1,5 @@
 
-SUBDIRS = libvirt-designer examples
+SUBDIRS = libvirt-designer examples docs
 
 ACLOCAL_AMFLAGS = -I m4
 
diff --git a/configure.ac b/configure.ac
index eb9c681..f082498 100644
--- a/configure.ac
+++ b/configure.ac
@@ -75,6 +75,7 @@ AC_OUTPUT(Makefile
           libvirt-designer/Makefile
           libvirt-designer.spec
           libvirt-designer-1.0.pc
+          docs/Makefile
           examples/Makefile)
 
 AC_MSG_NOTICE([])
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..d52bf52
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,42 @@
+DOC_MODULE=libvirt-designer
+
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+
+DOC_SOURCE_DIR=$(top_srcdir)/libvirt-designer
+
+SCANGOBJ_OPTIONS=
+
+SCAN_OPTIONS=--rebuild-sections --rebuild-types
+
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+MKTMPL_OPTIONS=
+
+MKHTML_OPTIONS=
+
+FIXXREF_OPTIONS=
+
+HFILE_GLOB=$(top_srcdir)/libvirt-designer/*.h
+CFILE_GLOB=$(top_srcdir)/libvirt-designer/*.c
+
+IGNORE_HFILES=
+
+HTML_IMAGES=
+
+content_files=
+
+expand_content_files=
+
+GTKDOC_CFLAGS= \
+	$(GOBJECT2_CFLAGS) \
+	$(LIBOSINFO_CFLAGS) \
+	$(LIBVIRT_GCONFIG_CFLAGS) \
+	$(LIBVIRT_GOBJECT_CFLAGS)
+GTKDOC_LIBS = \
+	$(GOBJECT2_LIBS) \
+	$(LIBOSINFO_LIBS) \
+	$(LIBVIRT_GCONFIG_LIBS) \
+	$(LIBVIRT_GOBJECT_LIBS) \
+	$(top_builddir)/libvirt-designer/libvirt-designer-1.0.la
+
+include $(top_srcdir)/gtk-doc.make
diff --git a/docs/libvirt-designer-docs.xml b/docs/libvirt-designer-docs.xml
new file mode 100644
index 0000000..2a151ab
--- /dev/null
+++ b/docs/libvirt-designer-docs.xml
@@ -0,0 +1,27 @@
+<?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>Libvirt-designer Reference Manual</title>
+  </bookinfo>
+
+  <chapter>
+    <title>Libvirt-designer</title>
+    <xi:include href="xml/libvirt-designer-domain.xml"/>
+    <xi:include href="xml/libvirt-designer-main.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>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
-- 
1.7.8.6


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]