[gxml] Removing gtk-doc documentation
- From: Daniel Espinosa Ortiz <despinosa src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gxml] Removing gtk-doc documentation
- Date: Tue, 17 Oct 2017 21:36:16 +0000 (UTC)
commit 0310652b807357b830ab766b4f1fbe6d47f7d8fe
Author: Daniel Espinosa <esodan gmail com>
Date: Tue Oct 17 16:31:43 2017 -0500
Removing gtk-doc documentation
Valadoc gtk-doc documentation generation is not working
and provides some bad advise to be available. So it is
now removed, until gtk-doc can be used to generate
documentation with Valadoc.
Fixes bug:
https://bugzilla.gnome.org/show_bug.cgi?id=788360
Makefile.am | 2 +-
configure.ac | 6 -----
docs/meson.build | 1 +
docs/valadoc/Makefile.am | 18 +++++++-------
docs/valadoc/devhelp/Makefile.am | 3 +-
examples/js/Makefile.am | 2 +-
gxml/Makefile.am | 45 +++++++++++++++++++++++++++++++++----
7 files changed, 53 insertions(+), 24 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index e640e7f..6688763 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -5,7 +5,7 @@ ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
# Set up subdirectories to traverse
-SUBDIRS = gxml test po examples debian docs
+SUBDIRS = gxml test po examples debian
# Define available flags
DISTCHECK_CONFIGURE_FLAGS = \
diff --git a/configure.ac b/configure.ac
index 9edff09..090ecc3 100644
--- a/configure.ac
+++ b/configure.ac
@@ -259,11 +259,6 @@ gxml/namespace-info.vala
gxml/gxml-$API_VERSION.pc:gxml/gxml.pc.in
gxml/Makefile
test/Makefile
-docs/Makefile
-docs/valadoc/Makefile
-docs/valadoc/devhelp/Makefile
-docs/valadoc/gtk-doc/Makefile
-docs/valadoc/gir-docs/Makefile
examples/Makefile
examples/c/Makefile
examples/js/Makefile
@@ -289,7 +284,6 @@ echo " Installation prefix: $prefix"
echo " GObject Introspection: $found_introspection"
echo " Documentation: ${docs}"
echo " DevHelp Docs: ${build_devhelp}"
-echo " Gtk-Docs: ${build_gtkdoc}"
echo " Enable Performance Test: $performance"
echo " Debug: $debug"
echo " Platform: $host"
diff --git a/docs/meson.build b/docs/meson.build
index 91057c3..25e8e5d 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -1,5 +1,6 @@
valadoc = find_program ('valadoc')
outdir ='GXml-'+API_VERSION
+gtkdoc_outdir ='gxml-'+API_VERSION
valacapi = run_command ('valac', '--api-version')
driver = '--driver='+valacapi.stdout().strip()
pkgname = '--package-name='+'GXml-'+API_VERSION
diff --git a/docs/valadoc/Makefile.am b/docs/valadoc/Makefile.am
index 2b7757d..cf8734f 100644
--- a/docs/valadoc/Makefile.am
+++ b/docs/valadoc/Makefile.am
@@ -1,14 +1,14 @@
SUBDIRS=
-if BUILD_DEVHELP_DOCS
-SUBDIRS+=devhelp
-endif
+# if BUILD_DEVHELP_DOCS
+# SUBDIRS+=devhelp
+# endif
-if BUILD_GTK_DOCS
-SUBDIRS+=gtk-doc
-endif
+# if BUILD_GTK_DOCS
+# SUBDIRS+=gtk-doc
+# endif
-if BUILD_GIR_DOCS
-SUBDIRS+=gir-docs
-endif
+# if BUILD_GIR_DOCS
+# SUBDIRS+=gir-docs
+# endif
diff --git a/docs/valadoc/devhelp/Makefile.am b/docs/valadoc/devhelp/Makefile.am
index 56c8070..0cfaf89 100644
--- a/docs/valadoc/devhelp/Makefile.am
+++ b/docs/valadoc/devhelp/Makefile.am
@@ -12,8 +12,7 @@ VALADOC_FLAGS = \
--pkg gee-0.8 \
--vapidir=$(top_srcdir)/gxml \
--vapidir=$(top_srcdir)/vapi \
- $(top_srcdir)/vapi/config.vapi \
- $(top_srcdir)/vapi/xlibxml-1.0.vapi
+ $(top_srcdir)/vapi/config.vapi
sources= \
$(top_srcdir)/gxml/*.vala
diff --git a/examples/js/Makefile.am b/examples/js/Makefile.am
index a0e6d93..1e64c67 100644
--- a/examples/js/Makefile.am
+++ b/examples/js/Makefile.am
@@ -1,3 +1,3 @@
EXTRA_DIST = bookshelf.xml bookshelf_node.xml bookshelf2.xml \
- attr.js cdata_section.js character_data.js comment.js document_create.js document_new_from_file.js
document_new_from_path.js document_new_from_string.js document_new.js document_properties.js
document_save_to_path.js element.js node_child_management.js node_list.js node_self.js text.js
+ character_data.js comment.js document_create.js document_new_from_file.js document_new_from_path.js
document_new_from_string.js document_new.js document_properties.js document_save_to_path.js element.js
node_child_management.js node_list.js node_self.js text.js
diff --git a/gxml/Makefile.am b/gxml/Makefile.am
index 62482cf..9fac86e 100644
--- a/gxml/Makefile.am
+++ b/gxml/Makefile.am
@@ -98,18 +98,21 @@ sources = \
GomSchema.vala \
$(NULL)
-
-AM_VALAFLAGS= \
+VALA_FLAGS= \
--vapidir=$(VAPIDIR) \
- $(ERROR_AM_VALAFLAGS) \
- --library=gxml-@API_VERSION@ \
$(top_srcdir)/vapi/config.vapi \
--vapidir=. \
--vapidir=$(top_srcdir)/vapi \
--pkg libxml-2.0 \
--pkg gee-0.8 \
--pkg gobject-2.0 \
- --pkg gio-2.0 \
+ --pkg gio-2.0
+
+AM_VALAFLAGS= \
+ $(VALA_FLAGS) \
+ --vapidir=$(VAPIDIR) \
+ $(ERROR_AM_VALAFLAGS) \
+ --library=gxml-@API_VERSION@ \
--includedir gxml \
-H gxml.h -C \
$(NULL)
@@ -286,3 +289,35 @@ CLEANFILES += \
-include $(top_srcdir)/git.mk
+if BUILD_DEVHELP_DOCS
+
+VALADOC_FLAGS = \
+ --driver $(VALA_API_VERSION) \
+ --force \
+ --package-name=GXml-$(API_VERSION) \
+ --package-version=$(PACKAGE_VERSION)
+
+gxmldocdir=$(datadir)/devhelp/books/GXml-$(API_VERSION)
+gxmldoc_DATA = \
+ devhelp/GXml-$(API_VERSION)/GXml-$(API_VERSION).devhelp2 \
+ devhelp/GXml-$(API_VERSION)/*.png \
+ devhelp/GXml-$(API_VERSION)/*.css \
+ devhelp/GXml-$(API_VERSION)/*.js \
+ devhelp/GXml-$(API_VERSION)/*.htm \
+ devhelp/GXml-$(API_VERSION)/*.html
+
+gxmldocimgdir=$(datadir)/devhelp/books/GXml-$(API_VERSION)/img
+gxmldocimg_DATA=\
+ devhelp/GXml-$(API_VERSION)/img/*
+
+$(gxmldoc_DATA) $(gxmldocimg_DATA): gxml-doc
+
+gxml-doc : $(sources)
+ $(VALADOC) -o devhelp --doclet=devhelp $(VALADOC_FLAGS) $(VALA_FLAGS) $^
+
+clean-local: clean-local-gxml-doc
+.PHONY: clean-local-gxml-doc
+clean-local-gxml-doc:
+ -rm -rf devhelp
+endif
+
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]