Commit bf3aee0c authored by Jiří Techet's avatar Jiří Techet

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.
parent 7902c613
Pipeline #57754 passed with stages
in 5 minutes and 28 seconds
......@@ -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
......
......@@ -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
......
......@@ -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
......
SUBDIRS=reference
if ENABLE_GTK
SUBDIRS+=reference-gtk
SUBDIRS=reference
endif
if build_gtk_doc
subdir('reference')
if build_gtk_widgetry
subdir('reference-gtk')
endif
endif
## Process this file with automake to produce Makefile.in
# We require automake 1.6 at least.
AUTOMAKE_OPTIONS = 1.6
# The name of the module, e.g. 'glib'.
DOC_MODULE=champlain-gtk
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
DOC_MODULE_VERSION=@CHAMPLAIN_API_VERSION@
# The top-level SGML file. You can change this if you want to.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
# The directory containing the source code. Relative to $(srcdir).
# 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-gtk
# 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="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=gtk_champlain
# 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=--extra-dir=../reference/html
# 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=
# 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 to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES= champlain-gtk-marshal.h champlain-gtk-enum-types.h champlain-gtk.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=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=$(DEPS_CFLAGS) -I$(top_srcdir) -I$(top_builddir)
GTKDOC_LIBS=$(DEPS_LIBS) $(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
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
EXTRA_DIST +=
# 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 your docs-status tested during 'make check'
if ENABLE_GTK_DOC
#TESTS_ENVIRONMENT = cd $(srcsrc) &&
#TESTS = $(GTKDOC_CHECK)
endif
-include $(top_srcdir)/git.mk
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>libchamplain-gtk Reference Manual</title>
<releaseinfo>
for libchamplain-gtk &version;
<para>
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://library.gnome.org/devel/libchamplain-gtk/unstable/">http://library.gnome.org/devel/libchamplain-gtk/unstable/</ulink>.
</para>
</releaseinfo>
<copyright>
<year>2008-2013</year>
<holder>libchamplain contributors</holder>
</copyright>
<legalnotice>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the <citetitle>GNU Free
Documentation License</citetitle>, Version 1.1 or any later
version published by the Free Software Foundation with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. You may obtain a copy of the <citetitle>GNU Free
Documentation License</citetitle> from the Free Software
Foundation by visiting <ulink type="http"
url="http://www.fsf.org">their Web site</ulink> or by writing
to:
<address>
The Free Software Foundation, Inc.,
<street>59 Temple Place</street> - Suite 330,
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
<country>USA</country>
</address>
</para>
</legalnotice>
</bookinfo>
<part>
<title>API Reference</title>
<xi:include href="xml/gtk-champlain-embed.xml"/>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</part>
</book>
<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>
gtk_prefix = gtk_dep.get_pkgconfig_variable('prefix')
gtk_docpath = join_paths(gtk_prefix, 'share', 'gtk-doc', 'html', 'gtk3')
libchamplain_gtk_reference_ignored_h = [
'champlain-gtk-enum-types.h',
'champlain-gtk-marshal.h',
'champlain-gtk.h',
]
version_xml = configuration_data()
version_xml.set('PACKAGE_VERSION', version)
configure_file(
input: 'version.xml.in',
output: 'version.xml',
configuration: version_xml,
install: false,
)
libchamplain_gtk_reference_scan_args = [
'--rebuild-types',
'--deprecated-guards=GTK_DISABLE_DEPRECATED',
'--ignore-headers=' + ' '.join(libchamplain_gtk_reference_ignored_h),
]
libchamplain_gtk_reference_mkdb_args = [
'--output-format=xml',
'--name-space=gtk_champlain',
]
libchamplain_gtk_reference_fixxref_args = [
'--html-dir=@0@'.format(join_paths(gtkdocdir, 'html', package_gtk_string)),
'--extra-dir=@0@'.format(gtk_docpath),
'--extra-dir=@0@'.format(join_paths(gtkdocdir, 'html', package_string)),
]
gnome.gtkdoc(
package_gtk_name,
main_xml: 'champlain-gtk-docs.xml',
mode: 'xml',
gobject_typesfile: files('champlain-gtk.types'),
src_dir: libchamplain_gtk_srcdir,
dependencies: libchamplain_gtk_dep,
scan_args: libchamplain_gtk_reference_scan_args,
mkdb_args: libchamplain_gtk_reference_mkdb_args,
fixxref_args: libchamplain_gtk_reference_fixxref_args,
install: true,
install_dir: join_paths(
gtkdocdir,
'html',
package_gtk_string,
)
)
......@@ -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
......
......@@ -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>
<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>
......
......@@ -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
......@@ -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,
......
......@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment