[libgda/LIBGDA_5.2] Fix browser doc generation
- From: Daniel Espinosa Ortiz <despinosa src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda/LIBGDA_5.2] Fix browser doc generation
- Date: Tue, 23 Apr 2019 19:06:31 +0000 (UTC)
commit 4b27c8ddb438b84e6e023e382eea87c64b3ec54d
Author: Daniel Espinosa <esodan gmail com>
Date: Tue Apr 23 14:05:38 2019 -0500
Fix browser doc generation
Fixes make distcheck too
Makefile.am | 2 +-
NEWS | 1 +
libgda-ui/Makefile.am | 2 +-
tools/browser/doc/Makefile.am | 72 ++++++++++++++++++---------------
tools/browser/doc/gda-browser-docs.sgml | 13 ++++++
5 files changed, 56 insertions(+), 34 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 0c7841db2..d2a8fbfd3 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-vala --enable-gi-system-install=no
+DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-vala --enable-gi-system-install=no --with-ui
--enable-tools
if HAVE_LIBXSLT
XSLT_DIR=libgda-xslt
diff --git a/NEWS b/NEWS
index 60df12614..24a1cccf5 100644
--- a/NEWS
+++ b/NEWS
@@ -4,6 +4,7 @@ libgda 5.2.9
- Drop unneeded JAVAH variable check
- Fix build for System Installed SQLite libs
- Non-Dates and Timestamps values returns 'NULL' string when converted
+ - Fix --with-ui, now UI is buildable when enable
libgda 5.2.8 2018-12-03
- Fix a typo on sv translation
diff --git a/libgda-ui/Makefile.am b/libgda-ui/Makefile.am
index 76106f7fe..5a47ddd3d 100644
--- a/libgda-ui/Makefile.am
+++ b/libgda-ui/Makefile.am
@@ -165,7 +165,7 @@ DTD_FILES = gdaui-layout.dtd
dtddir=$(datadir)/libgda-$(GDA_ABI_MAJOR_VERSION).$(GDA_ABI_MINOR_VERSION)/dtd
dtd_DATA=$(DTD_FILES)
-gdaui-resources.h gdaui-resources.c: $(srcdir)/gdaui.gresource.xml Makefile $(shell
$(GLIB_COMPILE_RESOURCES) --sourcedir=$(srcdir) --sourcedir=$(builddir) --generate-dependencies
$(srcdir)/gdaui.gresource.xml)
+gdaui-resources.h gdaui-resources.c: $(srcdir)/gdaui.gresource.xml
$(AM_V_GEN) $(GLIB_COMPILE_RESOURCES) --target=$@ --sourcedir=$(srcdir) --sourcedir=$(builddir)
--generate --c-name _gdaui --manual-register $<
EXTRA_DIST = $(DTD_FILES) \
diff --git a/tools/browser/doc/Makefile.am b/tools/browser/doc/Makefile.am
index 8fdc58c58..da7050dd0 100644
--- a/tools/browser/doc/Makefile.am
+++ b/tools/browser/doc/Makefile.am
@@ -1,29 +1,52 @@
## Process this file with automake to produce Makefile.in
-AUTOMAKE_OPTIONS = 1.6
-
# The name of the module.
DOC_MODULE=gda-browser
# The top-level SGML file.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=$(top_srcdir)/tools/browser
+
+
+# Extra options to pass to gtkdoc-scangobj
+SCANGOBJ_OPTIONS=--verbose
+
# Extra options to supply to gtkdoc-scan
SCAN_OPTIONS=--deprecated-guards="GDA_DISABLE_DEPRECATED"
-# Extra options to pass to gtkdoc-scangobj
-SCANGOBJ_OPTIONS=
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files="binreloc"
-# The directory containing the source code. Relative to $(srcdir)
-DOC_SOURCE_DIR=../
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Normally not needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
-# Used for dependencies.
+# 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=
CFILE_GLOB=
-# Header files to ignore when scanning
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# 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= marshal.h canvas dummy-perspective
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
+content_files = fdl-appendix.sgml
+
+# Images to copy into HTML directory
+HTML_IMAGES = UILayout.png
+
# CFLAGS and LDFLAGS for compiling scan program. Only needed
# if $(DOC_MODULE).types is non-empty.
GTKDOC_CFLAGS = -I$(top_srcdir) \
@@ -65,33 +88,18 @@ GTKDOC_LIBS = \
$(GTK_LIBS) \
$(GTKSOURCEVIEW_LIBS)
-# Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files="binreloc"
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
-content_files = fdl-appendix.sgml
-
-# Images to copy into HTML directory
-HTML_IMAGES = UILayout.png
-
-# Extra options to supply to gtkdoc-fixref
-FIXXREF_OPTIONS=
-
include $(top_srcdir)/gtk-doc.make
-# 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 = $(DOC_MODULE)-doc.pdf
+# Comment this out if you don't want 'make check' to test you doc status
+# and run some sanity checks
+# if ENABLE_GTK_DOC
+# TESTS_ENVIRONMENT = \
+# DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
+# SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
+# TESTS = $(GTKDOC_CHECK)
+# endif
+
-DOC_STAMPS += pdf-build.stamp
CLEANFILES += $(DOC_STAMPS)
-# Create the PDF
-PDF: pdf-build.stamp
-pdf-build.stamp:
- if test -f $(srcdir)/$(DOC_MAIN_SGML_FILE); then \
- dblatex $(srcdir)/$(DOC_MAIN_SGML_FILE) -o $(DOC_MODULE)-doc.pdf ; \
- fi
- touch pdf-build.stamp
diff --git a/tools/browser/doc/gda-browser-docs.sgml b/tools/browser/doc/gda-browser-docs.sgml
index b8243c7fe..6067ab03b 100644
--- a/tools/browser/doc/gda-browser-docs.sgml
+++ b/tools/browser/doc/gda-browser-docs.sgml
@@ -159,6 +159,19 @@
</chapter>
</part>
+ <part id="api-deprecated">
+ <title>API Deprecated</title>
+ <xi:include href="xml/api-index-deprecated.xml"/>
+ </part>
+ <part id="api-index-full">
+ <title>API Deprecated</title>
+ <xi:include href="xml/api-index-full.xml"/>
+ </part>
+ <part id="annotation-glossary">
+ <title>Annotation Glossary</title>
+ <xi:include href="xml/annotation-glossary.xml"/>
+ </part>
+
<part id="part_index">
<title>Appendix</title>
<xi:include href="fdl-appendix.sgml"/>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]