diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 482a1ca7b652dde2460c2dc6441522590600b2ae..64d22ce8fc80fc3efe558b0fd2f1c0923ed6df32 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -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 + 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 diff --git a/doc/C/.gitignore b/doc/C/.gitignore index 612ccec4869575cc09aef7c65fc6d51ee825bb0b..ba5014f291aa2337a2b7df6911ff4af46897c80c 100644 --- a/doc/C/.gitignore +++ b/doc/C/.gitignore @@ -1,5 +1,4 @@ html -xml html-build.stamp html.stamp libgda-6.0-decl-list.txt diff --git a/doc/C/libgda/libgda-6.0-docs.xml b/doc/C/libgda/libgda-6.0-docs.xml index aa01846411661c1e74349df9e43554eb1e1cb097..097b53fb31599c3b7b518734086e05f6a8496a5c 100644 --- a/doc/C/libgda/libgda-6.0-docs.xml +++ b/doc/C/libgda/libgda-6.0-docs.xml @@ -1,6 +1,6 @@ @@ -67,7 +67,7 @@ - + diff --git a/doc/C/libgda/meson.build b/doc/C/libgda/meson.build index 4b7023f770855fddc0addbb0999d35d3a5191cc8..95a3604dd85adf430d782a8fefe5a8c0a9fee5ba 100644 --- a/doc/C/libgda/meson.build +++ b/doc/C/libgda/meson.build @@ -1,3 +1,5 @@ +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 + ) diff --git a/doc/C/libgda/xml/gtkdocentities.ent.in b/doc/C/libgda/xml/gtkdocentities.ent.in new file mode 100644 index 0000000000000000000000000000000000000000..c311f64a93e556dbb7b4e70fd8c2eeba6141aa60 --- /dev/null +++ b/doc/C/libgda/xml/gtkdocentities.ent.in @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/doc/C/libgda/xml/meson.build b/doc/C/libgda/xml/meson.build new file mode 100644 index 0000000000000000000000000000000000000000..e60d5462c0ec68a7d853bdd548c296bd724a8ed0 --- /dev/null +++ b/doc/C/libgda/xml/meson.build @@ -0,0 +1,11 @@ +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) + diff --git a/doc/C/libgdaui/libgdaui-6.0-docs.xml b/doc/C/libgdaui/libgdaui-6.0-docs.xml new file mode 100644 index 0000000000000000000000000000000000000000..70587fa2e974440fb812391bcb543a405294f03a --- /dev/null +++ b/doc/C/libgdaui/libgdaui-6.0-docs.xml @@ -0,0 +1,146 @@ + + +]> + + + + libgda-ui Reference Manual + + for libgda-ui. + The latest version of this documentation can be found on-line at + https://gitlab.gnome.org/GNOME/libgda/pipelines, + from latest successful pipeline build. + + + + Connection + + + + + Data + + + + + + + + + + Data Cell Renderer + + + + + + + + + + + + Entry + + + + + + + + + + + + + + + + + + + + + + + + Misc + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Object Hierarchy + + + + + API Index + + + + Index of deprecated API + + + + Index of new API in 4.2 + + + + Index of new API in 4.2.2 + + + + Index of new API in 4.2.4 + + + + Index of new API in 4.2.8 + + + + Index of new API in 4.2.9 + + + + Index of new API in 5.0.3 + + + + Index of new API in 5.2 + + + + Index of new API in 6.0 + + + + diff --git a/doc/C/libgdaui/meson.build b/doc/C/libgdaui/meson.build index 02c8d6a1990c18205ae07f6534b8b5c57cd38d99..e4bf43c6064c33dee6bc5e64bf0132cd78e3938a 100644 --- a/doc/C/libgdaui/meson.build +++ b/doc/C/libgdaui/meson.build @@ -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 + ) diff --git a/meson.build b/meson.build index b7eabcb268589c59da90d6a7c6baafc2a5217a1a..db989a0b8345cf084caf90e173edeaccf101dd9f 100644 --- a/meson.build +++ b/meson.build @@ -1,7 +1,7 @@ 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',