From 5783e05f81bbf6debf2618c8994d6852630d9847 Mon Sep 17 00:00:00 2001 From: Behdad Esfahbod Date: Mon, 31 Aug 2015 19:18:10 +0100 Subject: [PATCH] [docs] Move docs/reference/ contents into docs/ --- configure.ac | 3 +- docs/Makefile.am | 117 ++++++++++++++++++- docs/{reference => }/harfbuzz-docs.xml | 0 docs/{reference => }/harfbuzz-overrides.txt | 0 docs/{reference => }/harfbuzz-sections.txt | 0 docs/reference/Makefile.am | 118 -------------------- docs/{reference => }/usermanual-ch01.xml | 0 docs/{reference => }/usermanual-ch02.xml | 0 docs/{reference => }/usermanual-ch03.xml | 0 docs/{reference => }/usermanual-ch04.xml | 0 docs/{reference => }/usermanual-ch05.xml | 0 docs/{reference => }/usermanual-ch06.xml | 0 docs/{reference => }/version.xml.in | 0 13 files changed, 117 insertions(+), 121 deletions(-) rename docs/{reference => }/harfbuzz-docs.xml (100%) rename docs/{reference => }/harfbuzz-overrides.txt (100%) rename docs/{reference => }/harfbuzz-sections.txt (100%) delete mode 100644 docs/reference/Makefile.am rename docs/{reference => }/usermanual-ch01.xml (100%) rename docs/{reference => }/usermanual-ch02.xml (100%) rename docs/{reference => }/usermanual-ch03.xml (100%) rename docs/{reference => }/usermanual-ch04.xml (100%) rename docs/{reference => }/usermanual-ch05.xml (100%) rename docs/{reference => }/usermanual-ch06.xml (100%) rename docs/{reference => }/version.xml.in (100%) diff --git a/configure.ac b/configure.ac index a73fe6201..2a0bc6a47 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 034926c59..f605f24b4 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 similarity index 100% rename from docs/reference/harfbuzz-docs.xml rename to docs/harfbuzz-docs.xml diff --git a/docs/reference/harfbuzz-overrides.txt b/docs/harfbuzz-overrides.txt similarity index 100% rename from docs/reference/harfbuzz-overrides.txt rename to docs/harfbuzz-overrides.txt diff --git a/docs/reference/harfbuzz-sections.txt b/docs/harfbuzz-sections.txt similarity index 100% rename from docs/reference/harfbuzz-sections.txt rename to docs/harfbuzz-sections.txt diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am deleted file mode 100644 index f605f24b4..000000000 --- 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 similarity index 100% rename from docs/reference/usermanual-ch01.xml rename to docs/usermanual-ch01.xml diff --git a/docs/reference/usermanual-ch02.xml b/docs/usermanual-ch02.xml similarity index 100% rename from docs/reference/usermanual-ch02.xml rename to docs/usermanual-ch02.xml diff --git a/docs/reference/usermanual-ch03.xml b/docs/usermanual-ch03.xml similarity index 100% rename from docs/reference/usermanual-ch03.xml rename to docs/usermanual-ch03.xml diff --git a/docs/reference/usermanual-ch04.xml b/docs/usermanual-ch04.xml similarity index 100% rename from docs/reference/usermanual-ch04.xml rename to docs/usermanual-ch04.xml diff --git a/docs/reference/usermanual-ch05.xml b/docs/usermanual-ch05.xml similarity index 100% rename from docs/reference/usermanual-ch05.xml rename to docs/usermanual-ch05.xml diff --git a/docs/reference/usermanual-ch06.xml b/docs/usermanual-ch06.xml similarity index 100% rename from docs/reference/usermanual-ch06.xml rename to docs/usermanual-ch06.xml diff --git a/docs/reference/version.xml.in b/docs/version.xml.in similarity index 100% rename from docs/reference/version.xml.in rename to docs/version.xml.in