Commit f1e2574d authored by Daniel Espinosa Ortiz's avatar Daniel Espinosa Ortiz

Merge branch 'pavlosun/libgda-meson-doc'

parents 0213b22e 84bda318
Pipeline #56894 passed with stage
in 17 minutes and 8 seconds
......@@ -133,39 +133,28 @@ meson_build:
- broadwayd &
- GDK_BACKEND=broadway meson test
- ninja install
- cd ..
artifacts:
when: on_failure
paths:
- _build/meson-logs/testlog.txt
- _build/meson-logs/meson-log.txt
- _build/doc/C/libgda/html
- _build/doc/C/libgdaui/html
- _build/doc/Gda-6.0
- _build/doc/Gdaui-6.0
expire_in: 1 week
pages:
stage: build
script:
- meson -Denable-gtk-doc=true _build
- cd _build
- ninja
- ninja install
- mkdir ../public
- mv doc/index.html ../public/
- mkdir ../public/C
- mv doc/C/* ../public/C/
- mkdir ../public/C/libgda-6.0
- mkdir ../public/C/libgdaui-6.0
- mv doc/C/libgda/html/* ../public/C/libgda-6.0
- mv doc/C/libgdaui/html/* ../public/C/libgdaui-6.0
- mkdir ../public/vala
- mv doc/Gda-6.0 ../public/vala
- mv doc/Gdaui-6.0 ../public/vala
- cp libgda/libgda-6.0.vapi ../public/vala
- cp libgda-ui/libgdaui-6.0.vapi ../public/vala
# Fix meson gtk-doc generation to remove next
- cd ..
- ./autogen.sh --enable-gtk-doc
- make
- mv doc/C/libgda/html public/C/libgda-6.0
- mv doc/C/libgdaui/html public/C/libgdaui-6.0
artifacts:
paths:
- public
\ No newline at end of file
- public
artifacts:
when: on_failure
paths:
- _build/meson-logs/testlog.txt
- _build/meson-logs/meson-log.txt
- _build/doc/C/libgda/html
- _build/doc/C/libgdaui/html
- _build/doc/Gda-6.0
- _build/doc/Gdaui-6.0
expire_in: 1 week
\ No newline at end of file
html
xml
html-build.stamp
html.stamp
libgda-6.0-decl-list.txt
......
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
......@@ -67,7 +67,7 @@
<xi:include href="xml/gda-data-proxy.xml"/>
<xi:include href="xml/gda-meta-store.xml"/>
<xi:include href="xml/gda-meta-struct.xml"/>
<xi:include href="xml/gda-data-select.xml"/>
<!-- <xi:include href="xml/gda-data-select.xml"/> -->
</chapter>
<chapter id="Data Handlers">
......
subdir('xml')
libgda_typesdoc = configure_file(
input: 'libgda.types.in',
output : 'libgda.types',
......@@ -60,31 +62,47 @@ contentf = [
doc_builddate
]
contentf += files([
'fdl-appendix.sgml'
'fdl-appendix.sgml',
'author-list.xml',
'installation.xml'
])
# ignore_bdb = []
# if bdb_found
# else
# ignore_bdb += ['gda-data-model-bdb.h']
# ignore_bdb += ['gda-data-model-bdb.h']
# endif
# gnome_module.gtkdoc(project_package,
# main_xml: project_package+'-docs.xml',
# scan_args: [
# '--deprecated-guards="GDA_DISABLE_DEPRECATED"',
# '--rebuild-types',
# '--ignore-headers',
# 'gda-marshal.h', 'gda-custom-marshal.h', 'gda-enum-types.h', 'sqlite3.h',
# 'csv.h', 'md5.h', 'jni-wrapper.h', 'gda-jdbc-recordset.h',
# 'gda-jdbc-blob-op.h', 'gda-jdbc-provider.h', 'gda-jdbc-pstmt.h',
# 'providers', 'tools control-center', 'tests', 'examples', 'plugins', 'tmp',
# ignore_bdb
# ],
# src_dir: join_paths(meson.source_root(),'libgda'),
# mkdb_args: [
# '--xml-mode',
# '--output-format=xml',
# '--name-space=gda'
# ],
# )
libgda_doc_dep = declare_dependency(link_with: [libgda])
glib_prefix = glib_dep.get_pkgconfig_variable('prefix')
glib_docpath = join_paths(glib_prefix, 'share', 'gtk-doc', 'html')
gnome_module.gtkdoc(
project_package,
main_xml: project_package+'-docs.xml',
namespace: 'gda',
mode: 'none',
src_dir: join_paths(meson.source_root(),'libgda'),
dependencies: [libgda_doc_dep, libgda_dep],
scan_args: [
'--deprecated-guards="GDA_DISABLE_DEPRECATED"',
'--rebuild-types'
],
content_files: contentf,
html_assets: gda_html_images,
fixxref_args: [
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')),
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'gobject')),
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'gio')),
],
ignore_headers: [
'gda-data-model-bdb.h',
'dummy-object.h',
'sqlite3.h'
],
mkdb_args: [
'--xml-mode'
],
install: true
)
<!ENTITY LIBGDA "@PACKAGE@">
<!ENTITY package_bugreport "@PACKAGE_BUGREPORT@">
<!ENTITY package_name "@PACKAGE_NAME@">
<!ENTITY package_string "@PACKAGE_STRING@">
<!ENTITY package_tarname "@PACKAGE_TARNAME@">
<!ENTITY package_url "@PACKAGE_URL@">
<!ENTITY package_version "@PACKAGE_VERSION@">
<!ENTITY package_api_version "@PACKAGE_API_VERSION@">
ent_conf = configuration_data()
ent_conf.set('PACKAGE', 'libgda')
ent_conf.set('PACKAGE_BUGREPORT', 'https://gitlab.gnome.org/GNOME/libgda/issues')
ent_conf.set('PACKAGE_NAME', 'libgda')
ent_conf.set('PACKAGE_STRING', 'libgda')
ent_conf.set('PACKAGE_TARNAME', 'libgda-' + meson.project_version())
ent_conf.set('PACKAGE_URL', 'http://gitlab.gnome.org/GNOME/libgda')
ent_conf.set('PACKAGE_VERSION', meson.project_version())
ent_conf.set('PACKAGE_API_VERSION', project_api_version)
configure_file(input: 'gtkdocentities.ent.in', output: 'gtkdocentities.ent', configuration: ent_conf)
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<book id="index-libgdaui">
<bookinfo>
<title>libgda-ui Reference Manual</title>
<releaseinfo>
for libgda-ui.
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="https://gitlab.gnome.org/GNOME/libgda/pipelines">https://gitlab.gnome.org/GNOME/libgda/pipelines</ulink>,
from latest successful pipeline build.
</releaseinfo>
</bookinfo>
<chapter id="Getting Started">
<title>Connection</title>
<xi:include href="xml/libgda-ui.xml"/>
</chapter>
<chapter id="Data">
<title>Data</title>
<xi:include href="xml/gdaui-data-entry.xml"/>
<xi:include href="xml/gdaui-data-selector.xml"/>
<xi:include href="xml/gdaui-data-filter.xml"/>
<xi:include href="xml/gdaui-data-proxy-info.xml"/>
<xi:include href="xml/gdaui-data-proxy.xml"/>
<xi:include href="xml/gdaui-data-store.xml"/>
</chapter>
<chapter id="Data Cell Renderer">
<title>Data Cell Renderer</title>
<xi:include href="xml/gdaui-data-cell-renderer-pict.xml"/>
<xi:include href="xml/gdaui-data-cell-renderer-textual.xml"/>
<xi:include href="xml/gdaui-data-cell-renderer-util.xml"/>
<xi:include href="xml/gdaui-data-cell-renderer-bin.xml"/>
<xi:include href="xml/gdaui-data-cell-renderer-boolean.xml"/>
<xi:include href="xml/gdaui-data-cell-renderer-combo.xml"/>
<xi:include href="xml/gdaui-data-cell-renderer-info.xml"/>
<!-- <xi:include href="xml/gdaui-data-cell-renderer-password.xml"/> -->
</chapter>
<chapter id="Entry">
<title>Entry</title>
<xi:include href="xml/gdaui-entry.xml"/>
<xi:include href="xml/gdaui-entry-combo.xml"/>
<xi:include href="xml/gdaui-entry-common-time.xml"/>
<xi:include href="xml/gdaui-entry-date.xml"/>
<xi:include href="xml/gdaui-entry-filesel.xml"/>
<xi:include href="xml/gdaui-entry-format.xml"/>
<xi:include href="xml/gdaui-entry-none.xml"/>
<xi:include href="xml/gdaui-entry-number.xml"/>
<!-- <xi:include href="xml/gdaui-entry-password.xml"/> -->
<xi:include href="xml/gdaui-entry-wrapper.xml"/>
<xi:include href="xml/gdaui-entry-string.xml"/>
<xi:include href="xml/gdaui-entry-rt.xml"/>
<xi:include href="xml/gdaui-entry-shell.xml"/>
<xi:include href="xml/gdaui-entry-bin.xml"/>
<xi:include href="xml/gdaui-entry-text.xml"/>
<xi:include href="xml/gdaui-entry-timestamp.xml"/>
<xi:include href="xml/gdaui-entry-cidr.xml"/>
<xi:include href="xml/gdaui-entry-time.xml"/>
<xi:include href="xml/gdaui-entry-boolean.xml"/>
<xi:include href="xml/gdaui-entry-pict.xml"/>
</chapter>
<chapter id="Misc">
<title>Misc</title>
<xi:include href="xml/gdaui-cloud.xml"/>
<xi:include href="xml/gdaui-plugin.xml"/>
<xi:include href="xml/gdaui-basic-form.xml"/>
<xi:include href="xml/gdaui-enums.xml"/>
<xi:include href="xml/gdaui-form.xml"/>
<xi:include href="xml/gdaui-grid.xml"/>
<xi:include href="xml/gdaui-login.xml"/>
<xi:include href="xml/gdaui-combo.xml"/>
<xi:include href="xml/gdaui-decl.xml"/>
<xi:include href="xml/gdaui-numeric-entry.xml"/>
<xi:include href="xml/gdaui-formatted-entry.xml"/>
<xi:include href="xml/gdaui-dsn-selector.xml"/>
<xi:include href="xml/gdaui-provider-selector.xml"/>
<xi:include href="xml/gdaui-easy.xml"/>
<xi:include href="xml/gdaui-provider-spec-editor.xml"/>
<xi:include href="xml/gdaui-raw-form.xml"/>
<xi:include href="xml/gdaui-raw-grid.xml"/>
<xi:include href="xml/gdaui-rt-editor.xml"/>
<xi:include href="xml/gdaui-server-operation.xml"/>
<xi:include href="xml/gdaui-set.xml"/>
<xi:include href="xml/gdaui-tree-store.xml"/>
<xi:include href="xml/gdaui-widget-embedder.xml"/>
<xi:include href="xml/gdaui-provider-auth-editor.xml"/>
<xi:include href="xml/common-bin.xml"/>
<xi:include href="xml/common-pict.xml"/>
<xi:include href="xml/popup-container.xml"/>
<xi:include href="xml/demo-common.xml"/>
</chapter>
<chapter id="object-tree">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index id="deprecated-api-index" role="deprecated">
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-4-2" role="4.2">
<title>Index of new API in 4.2</title>
<xi:include href="xml/api-index-4.2.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-4-2-2" role="4.2.2">
<title>Index of new API in 4.2.2</title>
<xi:include href="xml/api-index-4.2.2.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-4-2-4" role="4.2.4">
<title>Index of new API in 4.2.4</title>
<xi:include href="xml/api-index-4.2.4.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-4-2-8" role="4.2.8">
<title>Index of new API in 4.2.8</title>
<xi:include href="xml/api-index-4.2.8.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-4-2-9" role="4.2.9">
<title>Index of new API in 4.2.9</title>
<xi:include href="xml/api-index-4.2.9.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-5-0-3" role="5.0.3">
<title>Index of new API in 5.0.3</title>
<xi:include href="xml/api-index-5.0.3.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-5-2" role="5.2">
<title>Index of new API in 5.2</title>
<xi:include href="xml/api-index-5.2.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-6-0" role="6.0">
<title>Index of new API in 6.0</title>
<xi:include href="xml/api-index-6.0.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>
......@@ -6,4 +6,47 @@ doc_version = configure_file(
input: 'version.xml.in',
output: 'version.xml',
configuration: docui_conf
)
\ No newline at end of file
)
gdaui_html_images = files([
'vi-basic-form.png',
'vi-combo.png',
'vi-filter.png',
'vi-login.png',
'vi-raw-grid.png',
'vi-server-op.png',
'vi-cloud.png',
'vi-data-entry.png',
'vi-info.png',
'vi-provider-selector.png',
'vi-rte.png'
])
libgdaui_doc_dep = declare_dependency(link_with: [libgdaui, libgda_ui_plugins])
gnome_module.gtkdoc(
'libgdaui-'+project_api_version,
main_xml: 'libgdaui-'+project_api_version+'-docs.xml',
namespace: 'gdaui',
mode: 'none',
src_dir: join_paths(meson.source_root(),'libgda-ui'),
dependencies: [libgda_doc_dep, libgda_dep, libgdaui_doc_dep],
scan_args: [
'--deprecated-guards="GDA_DISABLE_DEPRECATED"',
'--rebuild-types'
],
ignore_headers: [
'gdaui-entry-password.h',
'gdaui-data-cell-renderer-password.h'
],
html_assets: gdaui_html_images,
fixxref_args: [
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')),
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'gobject')),
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'gio')),
],
mkdb_args: [
'--xml-mode'
],
install: true
)
project('libgda', 'vala', 'c',
license: 'LGPL2+',
version : '5.91.0',
meson_version: '>= 0.44.1',
meson_version: '>= 0.48',
default_options: [
'c_std=gnu11',
'warning_level=2',
......
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