summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBehdad Esfahbod <behdad@behdad.org>2015-08-31 19:18:10 +0100
committerBehdad Esfahbod <behdad@behdad.org>2015-08-31 19:18:10 +0100
commit5783e05f81bbf6debf2618c8994d6852630d9847 (patch)
treea1fda548c2516f9b9f63e70e7d9a31a7198e0402
parentcd5e3a13a6e0b6606d3a421f8cd44cdfb8314907 (diff)
downloadharfbuzz-5783e05f81bbf6debf2618c8994d6852630d9847.tar.gz
[docs] Move docs/reference/ contents into docs/
-rw-r--r--configure.ac3
-rw-r--r--docs/Makefile.am117
-rw-r--r--docs/harfbuzz-docs.xml (renamed from docs/reference/harfbuzz-docs.xml)0
-rw-r--r--docs/harfbuzz-overrides.txt (renamed from docs/reference/harfbuzz-overrides.txt)0
-rw-r--r--docs/harfbuzz-sections.txt (renamed from docs/reference/harfbuzz-sections.txt)0
-rw-r--r--docs/reference/Makefile.am118
-rw-r--r--docs/usermanual-ch01.xml (renamed from docs/reference/usermanual-ch01.xml)0
-rw-r--r--docs/usermanual-ch02.xml (renamed from docs/reference/usermanual-ch02.xml)0
-rw-r--r--docs/usermanual-ch03.xml (renamed from docs/reference/usermanual-ch03.xml)0
-rw-r--r--docs/usermanual-ch04.xml (renamed from docs/reference/usermanual-ch04.xml)0
-rw-r--r--docs/usermanual-ch05.xml (renamed from docs/reference/usermanual-ch05.xml)0
-rw-r--r--docs/usermanual-ch06.xml (renamed from docs/reference/usermanual-ch06.xml)0
-rw-r--r--docs/version.xml.in (renamed from docs/reference/version.xml.in)0
13 files changed, 117 insertions, 121 deletions
diff --git a/configure.ac b/configure.ac
index a73fe620..2a0bc6a4 100644
--- a/configure.ac
+++ b/configure.ac
@@ -442,8 +442,7 @@ test/Makefile
test/api/Makefile
test/shaping/Makefile
docs/Makefile
-docs/reference/Makefile
-docs/reference/version.xml
+docs/version.xml
])
AC_OUTPUT
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 034926c5..f605f24b 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,3 +1,118 @@
-SUBDIRS = reference
+# Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=harfbuzz
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=$(HB_VERSION_MAJOR)
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+
+# Directories containing the source code.
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
+DOC_SOURCE_DIR=$(top_srcdir)/src $(top_builddir)/src
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=--rebuild-types --deprecated-guards="HB_DISABLE_DEPRECATED"
+
+# Header files or dirs to ignore when scanning. Use base file/dir names
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
+IGNORE_HFILES=`cd $(top_srcdir)/src; find . -path './hb-*/*.h' | sed 's@^.*/@@'`
+if HAVE_GOBJECT
+else
+IGNORE_HFILES+=hb-gobject.h hb-gobject-enums.h hb-gobject-structs.h
+endif
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
+MKDB_OPTIONS=--source-suffixes=h,cc --xml-mode --output-format=xml --ignore-files="$(IGNORE_HFILES)"
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/src/hb.h $(top_srcdir)/src/hb-*.h
+CFILE_GLOB=$(top_srcdir)/src/hb-*.cc
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=$(top_builddir)/src/hb-version.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files= \
+ usermanual-ch01.xml \
+ usermanual-ch02.xml \
+ usermanual-ch03.xml \
+ usermanual-ch04.xml \
+ usermanual-ch05.xml \
+ usermanual-ch06.xml \
+ version.xml
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+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.
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=
+GTKDOC_LIBS=$(top_builddir)/src/libharfbuzz.la
+if HAVE_GOBJECT
+GTKDOC_LIBS+=$(top_builddir)/src/libharfbuzz-gobject.la
+endif
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST += version.xml.in
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want 'make check' to test you doc status
+# and run some sanity checks
+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
-include $(top_srcdir)/git.mk
diff --git a/docs/reference/harfbuzz-docs.xml b/docs/harfbuzz-docs.xml
index 60ff8e28..60ff8e28 100644
--- a/docs/reference/harfbuzz-docs.xml
+++ b/docs/harfbuzz-docs.xml
diff --git a/docs/reference/harfbuzz-overrides.txt b/docs/harfbuzz-overrides.txt
index e69de29b..e69de29b 100644
--- a/docs/reference/harfbuzz-overrides.txt
+++ b/docs/harfbuzz-overrides.txt
diff --git a/docs/reference/harfbuzz-sections.txt b/docs/harfbuzz-sections.txt
index 3612dad6..3612dad6 100644
--- a/docs/reference/harfbuzz-sections.txt
+++ b/docs/harfbuzz-sections.txt
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
deleted file mode 100644
index f605f24b..00000000
--- a/docs/reference/Makefile.am
+++ /dev/null
@@ -1,118 +0,0 @@
-# Process this file with automake to produce Makefile.in
-
-# We require automake 1.6 at least.
-AUTOMAKE_OPTIONS = 1.6
-
-# This is a blank Makefile.am for using gtk-doc.
-# Copy this to your project's API docs directory and modify the variables to
-# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
-# of using the various options.
-
-# The name of the module, e.g. 'glib'.
-DOC_MODULE=harfbuzz
-
-# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
-#DOC_MODULE_VERSION=$(HB_VERSION_MAJOR)
-
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
-
-# Directories containing the source code.
-# gtk-doc will search all .c and .h files beneath these paths
-# for inline comments documenting functions and macros.
-# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
-DOC_SOURCE_DIR=$(top_srcdir)/src $(top_builddir)/src
-
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
-
-# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=--rebuild-types --deprecated-guards="HB_DISABLE_DEPRECATED"
-
-# Header files or dirs to ignore when scanning. Use base file/dir names
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
-IGNORE_HFILES=`cd $(top_srcdir)/src; find . -path './hb-*/*.h' | sed 's@^.*/@@'`
-if HAVE_GOBJECT
-else
-IGNORE_HFILES+=hb-gobject.h hb-gobject-enums.h hb-gobject-structs.h
-endif
-
-# Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
-MKDB_OPTIONS=--source-suffixes=h,cc --xml-mode --output-format=xml --ignore-files="$(IGNORE_HFILES)"
-
-# Extra options to supply to gtkdoc-mktmpl
-# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkhtml
-MKHTML_OPTIONS=
-
-# Extra options to supply to gtkdoc-fixref. Not normally needed.
-# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
-
-# Used for dependencies. The docs will be rebuilt if any of these change.
-# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
-# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/src/hb.h $(top_srcdir)/src/hb-*.h
-CFILE_GLOB=$(top_srcdir)/src/hb-*.cc
-
-# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
-# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
-EXTRA_HFILES=$(top_builddir)/src/hb-version.h
-
-# Images to copy into HTML directory.
-# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files= \
- usermanual-ch01.xml \
- usermanual-ch02.xml \
- usermanual-ch03.xml \
- usermanual-ch04.xml \
- usermanual-ch05.xml \
- usermanual-ch06.xml \
- version.xml
-
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
-# These files must be listed here *and* in content_files
-# e.g. expand_content_files=running.sgml
-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.
-# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-GTKDOC_CFLAGS=
-GTKDOC_LIBS=$(top_builddir)/src/libharfbuzz.la
-if HAVE_GOBJECT
-GTKDOC_LIBS+=$(top_builddir)/src/libharfbuzz-gobject.la
-endif
-
-# This includes the standard gtk-doc make rules, copied by gtkdocize.
-include $(top_srcdir)/gtk-doc.make
-
-# Other files to distribute
-# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST += version.xml.in
-
-# Files not to distribute
-# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
-# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-#DISTCLEANFILES +=
-
-# Comment this out if you want 'make check' to test you doc status
-# and run some sanity checks
-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
-
--include $(top_srcdir)/git.mk
diff --git a/docs/reference/usermanual-ch01.xml b/docs/usermanual-ch01.xml
index 3574d75a..3574d75a 100644
--- a/docs/reference/usermanual-ch01.xml
+++ b/docs/usermanual-ch01.xml
diff --git a/docs/reference/usermanual-ch02.xml b/docs/usermanual-ch02.xml
index 34db017a..34db017a 100644
--- a/docs/reference/usermanual-ch02.xml
+++ b/docs/usermanual-ch02.xml
diff --git a/docs/reference/usermanual-ch03.xml b/docs/usermanual-ch03.xml
index 3a26c553..3a26c553 100644
--- a/docs/reference/usermanual-ch03.xml
+++ b/docs/usermanual-ch03.xml
diff --git a/docs/reference/usermanual-ch04.xml b/docs/usermanual-ch04.xml
index 01fcdc99..01fcdc99 100644
--- a/docs/reference/usermanual-ch04.xml
+++ b/docs/usermanual-ch04.xml
diff --git a/docs/reference/usermanual-ch05.xml b/docs/usermanual-ch05.xml
index 470bab8d..470bab8d 100644
--- a/docs/reference/usermanual-ch05.xml
+++ b/docs/usermanual-ch05.xml
diff --git a/docs/reference/usermanual-ch06.xml b/docs/usermanual-ch06.xml
index ca674c0c..ca674c0c 100644
--- a/docs/reference/usermanual-ch06.xml
+++ b/docs/usermanual-ch06.xml
diff --git a/docs/reference/version.xml.in b/docs/version.xml.in
index de213c2d..de213c2d 100644
--- a/docs/reference/version.xml.in
+++ b/docs/version.xml.in