GNOME.org
 

[libchamplain] Combine champlain and champlain-gtk documentations into one

commit bf3aee0c8869377d39de5ff6708b04fccfac559e
Author: Jiří Techet <techet gmail com>
Date:   Sat Feb 9 17:44:25 2019 +0100

    Combine champlain and champlain-gtk documentations into one
    
    It makes no sense to keep them separate (especially when there's almost
    nothing in champlain-gtk). Building documentation requires gtk enabled now.

 .gitlab-ci.yml                                |  3 -
 README.md                                     |  1 -
 configure.ac                                  |  4 +-
 docs/Makefile.am                              |  5 +-
 docs/meson.build                              |  3 -
 docs/reference-gtk/Makefile.am                | 97 ---------------------------
 docs/reference-gtk/champlain-gtk-docs.xml     | 48 -------------
 docs/reference-gtk/champlain-gtk-sections.txt | 18 -----
 docs/reference-gtk/champlain-gtk.types        |  1 -
 docs/reference-gtk/meson.build                | 53 ---------------
 docs/reference-gtk/version.xml.in             |  1 -
 docs/reference/Makefile.am                    | 24 ++++---
 docs/reference/champlain-docs.xml             | 40 +++++------
 docs/reference/champlain-sections.txt         | 19 ++++++
 docs/reference/champlain.types                |  1 +
 docs/reference/meson.build                    | 11 ++-
 meson.build                                   | 12 ++--
 17 files changed, 73 insertions(+), 268 deletions(-)
---
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 5d8a6d0..f5322c1 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -23,13 +23,11 @@ build-champlain:
     - ninja -C _build
     - ninja -C _build test
     - ninja -C _build champlain-doc
-    - ninja -C _build champlain-gtk-doc
     - ccache --show-stats
   artifacts:
     name: "champlain-doc"
     paths:
       - _build/docs/reference/html
-      - _build/docs/reference-gtk/html
   cache:
     key: "$CI_JOB_NAME"
     paths:
@@ -43,7 +41,6 @@ pages:
   script:
     - mkdir -p public/
     - mv _build/docs/reference/html/ public/champlain/
-    - mv _build/docs/reference-gtk/html/ public/champlain-gtk/
   artifacts:
     paths:
       - public
diff --git a/README.md b/README.md
index 865054e..e5fc94c 100644
--- a/README.md
+++ b/README.md
@@ -37,7 +37,6 @@ points to see how to get the most basic map application running.
 
 Full **documentation** can be found at:
 * https://gnome.pages.gitlab.gnome.org/libchamplain/champlain
-* https://gnome.pages.gitlab.gnome.org/libchamplain/champlain-gtk
 
 The official **mailing list** is at:
 * https://mail.gnome.org/mailman/listinfo/libchamplain-list
diff --git a/configure.ac b/configure.ac
index a89ecb6..42d9804 100644
--- a/configure.ac
+++ b/configure.ac
@@ -76,7 +76,7 @@ AC_SUBST(DEPS_LIBS)
 AM_PATH_GLIB_2_0(2.38.0,,gobject gthread gio)
 
 # check for gtk-doc
-GTK_DOC_CHECK(1.9)
+GTK_DOC_CHECK(1.15)
 
 GNOME_COMPILE_WARNINGS([maximum])
 GNOME_MAINTAINER_MODE_DEFINES
@@ -200,8 +200,6 @@ AC_CONFIG_FILES([Makefile
                  docs/Makefile
                  docs/reference/Makefile
                  docs/reference/version.xml
-                 docs/reference-gtk/Makefile
-                 docs/reference-gtk/version.xml
                  champlain-$CHAMPLAIN_API_VERSION.pc:champlain.pc.in
                  champlain-$CHAMPLAIN_API_VERSION-uninstalled.pc:champlain-uninstalled.pc.in
                  champlain-gtk-$CHAMPLAIN_API_VERSION.pc:champlain-gtk.pc.in
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 2a2a881..c31b80f 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,6 +1,3 @@
-SUBDIRS=reference
-
 if ENABLE_GTK
-  SUBDIRS+=reference-gtk
+  SUBDIRS=reference
 endif
-
diff --git a/docs/meson.build b/docs/meson.build
index eb240b7..84a9c7a 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -1,6 +1,3 @@
 if build_gtk_doc
   subdir('reference')
-  if build_gtk_widgetry
-    subdir('reference-gtk')
-  endif
 endif
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index fed635e..6f59df8 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -17,7 +17,9 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
 # gtk-doc will search all .c & .h files beneath here for inline comments
 # documenting the functions and macros.
 # e.g. DOC_SOURCE_DIR=../../../gtk
-DOC_SOURCE_DIR=../../champlain
+DOC_SOURCE_DIR=\
+       ../../champlain \
+       ../../champlain-gtk
 
 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
 SCANGOBJ_OPTIONS=
@@ -28,7 +30,7 @@ SCAN_OPTIONS=--rebuild-types --deprecated-guards="GTK_DISABLE_DEPRECATED"
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--xml-mode --output-format=xml --name-space=champlain
+MKDB_OPTIONS=--xml-mode --output-format=xml --name-space=champlain --name-space=gtk_champlain
 
 # Extra options to supply to gtkdoc-mktmpl
 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
@@ -44,22 +46,26 @@ 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)/champlain/*.h
-CFILE_GLOB=$(top_srcdir)/champlain/*.c
+HFILE_GLOB=$(top_srcdir)/champlain/*.h $(top_srcdir)/champlain-gtk/*.h
+CFILE_GLOB=$(top_srcdir)/champlain/*.c $(top_srcdir)/champlain-gtk/*.c
 
 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
 EXTRA_HFILES=
 
 if ENABLE_MEMPHIS
-ignored_headers=
+memphis_headers=
 else
-ignored_headers=champlain-memphis-renderer.h
+memphis_headers=champlain-memphis-renderer.h
 endif
 
 # Header files to ignore when scanning. Use base file name, no paths
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES= $(ignored_headers) \
+IGNORE_HFILES=\
+       champlain-gtk-marshal.h \
+       champlain-gtk-enum-types.h \
+       champlain-gtk.h \
+       $(memphis_headers) \
        champlain-debug.h \
        champlain-enum-types.h \
        champlain-private.h \
@@ -90,7 +96,9 @@ expand_content_files=
 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
 GTKDOC_CFLAGS=$(DEPS_CFLAGS) -I$(top_srcdir) -I$(top_builddir)
-GTKDOC_LIBS=$(DEPS_LIBS) $(top_builddir)/champlain/libchamplain-@CHAMPLAIN_API_VERSION@.la
+GTKDOC_LIBS=$(DEPS_LIBS) \
+       $(top_builddir)/champlain/libchamplain-@CHAMPLAIN_API_VERSION@.la\
+       $(top_builddir)/champlain-gtk/libchamplain-gtk-@CHAMPLAIN_API_VERSION@.la
 
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
diff --git a/docs/reference/champlain-docs.xml b/docs/reference/champlain-docs.xml
index 6f77605..24247e6 100644
--- a/docs/reference/champlain-docs.xml
+++ b/docs/reference/champlain-docs.xml
@@ -41,7 +41,8 @@
   </bookinfo>
 
   <part>
-    <title>Basic API</title>
+    <title>Core API</title>
+    <xi:include href="xml/gtk-champlain-embed.xml"/>
     <xi:include href="xml/champlain-view.xml"/>
   </part>
   <part>
@@ -113,38 +114,37 @@
   </part>
 
   <index>
-    <title>Index</title>
+    <title>Index of all symbols</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
   </index>
 
   <index role="deprecated">
     <title>Index of deprecated symbols</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index role="0.1">
-    <title>Index of new symbols in 0.1</title>
+  <index role="0.12.10">
+    <title>Index of new symbols in 0.12.10</title>
+    <xi:include href="xml/api-index-0.12.10.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index role="0.2">
-    <title>Index of new symbols in 0.2</title>
+  <index role="0.12.12">
+    <title>Index of new symbols in 0.12.12</title>
+    <xi:include href="xml/api-index-0.12.12.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index role="0.4">
-    <title>Index of new symbols in 0.4</title>
+  <index role="0.12.14">
+    <title>Index of new symbols in 0.12.14</title>
+    <xi:include href="xml/api-index-0.12.14.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index role="0.6">
-    <title>Index of new symbols in 0.6</title>
+  <index role="0.12.16">
+    <title>Index of new symbols in 0.12.16</title>
+    <xi:include href="xml/api-index-0.12.16.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index role="0.8">
-    <title>Index of new symbols in 0.8</title>
-  </index>
-
-  <index role="0.10">
-    <title>Index of new symbols in 0.10</title>
-  </index>
-
-  <index role="0.12">
-    <title>Index of new symbols in 0.12</title>
+  <index role="0.12.18">
+    <title>Index of new symbols in 0.12.18</title>
+    <xi:include href="xml/api-index-0.12.18.xml"><xi:fallback /></xi:include>
   </index>
 </book>
diff --git a/docs/reference/champlain-sections.txt b/docs/reference/champlain-sections.txt
index 45409c4..eafcc0e 100644
--- a/docs/reference/champlain-sections.txt
+++ b/docs/reference/champlain-sections.txt
@@ -1,3 +1,22 @@
+<SECTION>
+<FILE>gtk-champlain-embed</FILE>
+<TITLE>GtkChamplainEmbed</TITLE>
+GtkChamplainEmbed
+gtk_champlain_embed_new
+gtk_champlain_embed_get_view
+<SUBSECTION Standard>
+GTK_CHAMPLAIN_TYPE_EMBED
+GTK_CHAMPLAIN_EMBED
+GTK_CHAMPLAIN_IS_EMBED
+gtk_champlain_embed_get_type
+GTK_CHAMPLAIN_EMBED_CLASS
+GTK_CHAMPLAIN_IS_EMBED_CLASS
+GTK_CHAMPLAIN_EMBED_GET_CLASS
+<SUBSECTION Private>
+GtkChamplainEmbedClass
+GtkChamplainEmbedPrivate
+</SECTION>
+
 <SECTION>
 <FILE>champlain-map-source</FILE>
 <TITLE>ChamplainMapSource</TITLE>
diff --git a/docs/reference/champlain.types b/docs/reference/champlain.types
index 04a0111..a99ecde 100644
--- a/docs/reference/champlain.types
+++ b/docs/reference/champlain.types
@@ -28,3 +28,4 @@ champlain_tile_cache_get_type
 champlain_tile_get_type
 champlain_tile_source_get_type
 champlain_view_get_type
+gtk_champlain_embed_get_type
diff --git a/docs/reference/meson.build b/docs/reference/meson.build
index 2533f00..299dc74 100644
--- a/docs/reference/meson.build
+++ b/docs/reference/meson.build
@@ -7,7 +7,13 @@ gobject_docpath = join_paths(gobject_prefix, 'share', 'gtk-doc', 'html', 'gobjec
 clutter_prefix = clutter_dep.get_pkgconfig_variable('prefix')
 clutter_docpath = join_paths(clutter_prefix, 'share', 'gtk-doc', 'html', 'clutter')
 
+gtk_prefix = gtk_dep.get_pkgconfig_variable('prefix')
+gtk_docpath = join_paths(gtk_prefix, 'share', 'gtk-doc', 'html', 'gtk3')
+
 libchamplain_reference_ignored_h = [
+  'champlain-gtk-enum-types.h',
+  'champlain-gtk-marshal.h',
+  'champlain-gtk.h',
   'champlain-adjustment.h',
   'champlain-debug.h',
   'champlain-defines.h',
@@ -45,6 +51,7 @@ libchamplain_reference_scan_args = [
 libchamplain_reference_mkdb_args = [
   '--output-format=xml',
   '--name-space=champlain',
+  '--name-space=gtk_champlain',
 ]
 
 libchamplain_reference_fixxref_args = [
@@ -59,8 +66,8 @@ gnome.gtkdoc(
   main_xml: 'champlain-docs.xml',
   mode: 'xml',
   gobject_typesfile: files('champlain.types'),
-  src_dir: libchamplain_srcdir,
-  dependencies: libchamplain_dep,
+  src_dir: [libchamplain_srcdir, libchamplain_gtk_srcdir],
+  dependencies: [libchamplain_dep, libchamplain_gtk_dep],
   scan_args: libchamplain_reference_scan_args,
   mkdb_args: libchamplain_reference_mkdb_args,
   fixxref_args: libchamplain_reference_fixxref_args,
diff --git a/meson.build b/meson.build
index 318b110..31a96d6 100644
--- a/meson.build
+++ b/meson.build
@@ -72,7 +72,7 @@ libsoup_req = '>= 2.42'
 memphis_req = '>= 0.2.1'
 introspection_req = '>= 0.6.3'
 vala_req = '>= 0.11.0'
-gtk_doc_req = '>= 1.9'
+gtk_doc_req = '>= 1.15'
 
 glib_dep = dependency('glib-2.0', version: glib_req)
 gobject_dep = dependency('gobject-2.0', version: glib_req)
@@ -102,16 +102,16 @@ configure_file(
 # Options
 build_demos = get_option('demos')
 
-build_gtk_doc = get_option('gtk_doc')
-if build_gtk_doc and not gtk_doc_dep.found()
-  build_gtk_doc = false
-endif
-
 build_gtk_widgetry = get_option('widgetry')
 if build_gtk_widgetry and not (gtk_dep.found() and clutter_gtk_dep.found())
   build_gtk_widgetry = false
 endif
 
+build_gtk_doc = get_option('gtk_doc')
+if build_gtk_doc and not (gtk_doc_dep.found() and build_gtk_widgetry)
+  build_gtk_doc = false
+endif
+
 generate_gir = get_option('introspection')
 if generate_gir and not introspection_dep.found()
   generate_gir = false
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]