[pango/gi-docs: 10/30] Generate Pango API docs with gi-docgen

From: Matthias Clasen <matthiasc src gnome org>
To: commits-list gnome org
Cc:
Subject: [pango/gi-docs: 10/30] Generate Pango API docs with gi-docgen
Date: Wed, 17 Feb 2021 07:07:15 +0000 (UTC)

commit a65970a22e44c98413af39221a8a2c759b73e87e
Author: Matthias Clasen <mclasen redhat com>
Date:   Wed Feb 10 16:49:26 2021 -0500

    Generate Pango API docs with gi-docgen
    
    Stop using gtk-doc, and switch to gi-docgen.
    
    The gi-docgen tool generates API references through the introspection
    data, which has various benefits:
    
     - it does not parse C code
     - it does not generate and run C code to introspect types at build time
     - it does not present a different API from the one we're exporting
    
    Additionally, gi-docgen:
    
     - does not generate DocBook XML in order to generate HTML
     - does not go through xsltproc
     - parses proper Markdown
    
    Which makes it markedly faster than gtk-doc has ever been.

 docs/meson.build                             | 219 +++++++++++++++++----------
 docs/{pango.toml => pango.toml.in}           |   2 +-
 docs/{pangocairo.toml => pangocairo.toml.in} |   2 +-
 docs/{pangofc.toml => pangofc.toml.in}       |   2 +-
 docs/{pangoft2.toml => pangoft2.toml.in}     |   2 +-
 docs/{pangoot.toml => pangoot.toml.in}       |   2 +-
 docs/{pangoxft.toml => pangoxft.toml.in}     |   2 +-
 docs/rects3.png                              | Bin 0 -> 17137 bytes
 meson.build                                  |   4 +
 9 files changed, 150 insertions(+), 85 deletions(-)
---
diff --git a/docs/meson.build b/docs/meson.build
index e847a34f..aa68b59b 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -1,97 +1,158 @@
-subdir('xml')
+gidocgen = find_program('gi-docgen', required: get_option('gtk_doc'))
 
-version_xml_conf = configuration_data()
-version_xml_conf.set('PANGO_VERSION', meson.project_version())
-configure_file(input: 'version.xml.in',
-               output: 'version.xml',
-               configuration: version_xml_conf)
-
-private_headers = [
-  'pangocairo-private.h',
-  'pangocairo-fc-private.h',
-  'pangocairo-fc.h',
-  'pangocairo-win32.h',
-  'pangocairo-atsui.h',
-  'pango-coverage-private.h',
-  'pango-color-table.h',
-  'pango-emoji-private.h',
-  'pango-font-private.h',
-  'pango-fontmap-private.h',
-  'pango-fontset-private.h',
-  'pango-impl-utils.h',
-  'pango-glyph-item-private.h',
-  'pango-layout-private.h',
-  'pango-script-table.h',
-  'pango-script-private.h',
-  'pango-utils-private.h',
-  'pangofc-private.h',
-  'pangofc-fontmap-private.h',
-  'pangoft2-private.h',
-  'pangowin32-private.h',
-  'pangoatsui-private.h',
-  'pangoxft-private.h',
-  'pango-ot-private.h',
-  'pango-script-lang-table.h',
-  'pango-language-sample-table.h',
-  'pangocoretext-private.h',
-]
-
-content_files = [
-  'pango_markup.sgml',
-  'version.xml',
-]
-
-html_images = [
+pango_content_files = [
+  'pango-name.png',
   'layout.png',
   'pipeline.png',
-  'rotated-text.png',
   'rects1.png',
   'rects2.png',
+  'rects3.png',
 ]
 
-docdeps = [ libpango_dep ]
+doc_conf = configuration_data()
+doc_conf.set('PANGO_VERSION', meson.project_version())
+
+pango_toml = configure_file(input: 'pango.toml.in',
+                            output: 'pango.toml',
+                            configuration: doc_conf)
+
+custom_target('pango-doc',
+  input: pango_gir[0],
+  output: 'Pango',
+  command: [
+    gidocgen,
+    'generate',
+    '--quiet',
+    '--add-include-path=@0@'.format(meson.current_build_dir() / '../pango'),
+    '--config', pango_toml,
+    '--output-dir=@OUTPUT@',
+    '--no-namespace-dir',
+    '--content-dir=@0@'.format(meson.current_source_dir()),
+    '@INPUT@',
+  ],
+  depend_files: [ pango_toml, pango_content_files],
+  build_by_default: true,
+)
 
 if build_pangoft2
-  docdeps += libpangoft2_dep
+  pangoft2_toml = configure_file(input: 'pangoft2.toml.in',
+                                 output: 'pangoft2.toml',
+                                 configuration: doc_conf)
+
+  custom_target('pangoft-doc',
+    input: pangoft2_gir[0],
+    output: 'PangoFT2',
+    command: [
+      gidocgen,
+      'generate',
+      '--quiet',
+      '--add-include-path=@0@'.format(meson.current_build_dir() / '../pango'),
+      '--config', pangoft2_toml,
+      '--output-dir=@OUTPUT@',
+      '--no-namespace-dir',
+      '--content-dir=@0@'.format(meson.current_source_dir()),
+      '@INPUT@',
+    ],
+    depend_files: [ pangoft2_toml, 'pango-name.png' ],
+    build_by_default: true,
+  )
 endif
 
 if xft_dep.found() and fontconfig_dep.found()
-  docdeps += libpangoxft_dep
+  pangoxft_toml = configure_file(input: 'pangoxft.toml.in',
+                                 output: 'pangoxft.toml',
+                                 configuration: doc_conf)
+
+  custom_target('pangoxft-doc',
+    input: pangoxft_gir[0],
+    output: 'PangoXft',
+    command: [
+      gidocgen,
+      'generate',
+      '--quiet',
+      '--add-include-path=@0@'.format(meson.current_build_dir() / '../pango'),
+      '--config', pangoxft_toml,
+      '--output-dir=@OUTPUT@',
+      '--no-namespace-dir',
+      '--content-dir=@0@'.format(meson.current_source_dir()),
+      '@INPUT@',
+    ],
+    depend_files: [ pangoxft_toml, 'pango-name.png' ],
+    build_by_default: true,
+  )
 endif
 
 if cairo_dep.found()
-  docdeps += libpangocairo_dep
+  pangocairo_content_files = [
+    'pango-name.png',
+    'rotated-text.png',
+  ]
+
+  pangocairo_toml = configure_file(input: 'pangocairo.toml.in',
+                                   output: 'pangocairo.toml',
+                                   configuration: doc_conf)
+
+  custom_target('pangocairo-doc',
+    input: pangocairo_gir[0],
+    output: 'PangoCairo',
+    command: [
+      gidocgen,
+      'generate',
+      '--quiet',
+      '--add-include-path=@0@'.format(meson.current_build_dir() / '../pango'),
+      '--config', pangocairo_toml,
+      '--output-dir=@OUTPUT@',
+      '--no-namespace-dir',
+      '--content-dir=@0@'.format(meson.current_source_dir()),
+      '@INPUT@',
+    ],
+    depend_files: [ pangocairo_toml, pangocairo_content_files ],
+    build_by_default: true,
+  )
 endif
 
-glib_prefix = dependency('glib-2.0').get_pkgconfig_variable('prefix')
-glib_docpath = join_paths(glib_prefix, 'share', 'gtk-doc', 'html')
-cairo_prefix = dependency('cairo').get_pkgconfig_variable('prefix')
-cairo_docpath = join_paths(cairo_prefix, 'share', 'gtk-doc', 'html')
-docpath = join_paths(pango_datadir, 'gtk-doc', 'html')
+pangoot_toml = configure_file(input: 'pangoot.toml.in',
+                              output: 'pangoot.toml',
+                              configuration: doc_conf)
 
-gnome.gtkdoc('pango',
-             main_xml: 'pango-docs.sgml',
-             src_dir: [
-               pango_inc,
-             ],
-             dependencies: docdeps,
-             gobject_typesfile: configure_file(input: 'pango.types.in',
-                                               output: 'pango.types',
-                                               configuration: pango_conf),
-             scan_args: [
-               '--deprecated-guards=PANGO_DISABLE_DEPRECATED',
-               '--ignore-decorators=_PANGO_EXTERN',
-               '--ignore-headers=' + ' '.join(private_headers),
-             ],
-             mkdb_args: [
-               '--sgml-mode',
-               '--output-format=xml',
-             ],
-             fixxref_args: [
-               '--html-dir=@0@'.format(docpath),
-               '--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')),
-               '--extra-dir=@0@'.format(join_paths(glib_docpath, 'gobject')),
-               '--extra-dir=@0@'.format(join_paths(cairo_docpath, 'cairo')),
-             ],
-             html_assets: html_images,
-             install: true)
+custom_target('pangoot-doc',
+  input: pangoot_gir[0],
+  output: 'PangoOT',
+  command: [
+    gidocgen,
+    'generate',
+    '--quiet',
+    '--add-include-path=@0@'.format(meson.current_build_dir() / '../pango'),
+    '--config', pangoot_toml,
+    '--output-dir=@OUTPUT@',
+    '--no-namespace-dir',
+    '--content-dir=@0@'.format(meson.current_source_dir()),
+    '@INPUT@',
+  ],
+  depend_files: [ pangoot_toml, 'pango-name.png' ],
+  build_by_default: true,
+)
+
+if fontconfig_dep.found()
+  pangofc_toml = configure_file(input: 'pangofc.toml.in',
+                                output: 'pangofc.toml',
+                                configuration: doc_conf)
+
+  custom_target('pangofc-doc',
+    input: pangofc_gir[0],
+    output: 'PangoFc',
+    command: [
+      gidocgen,
+      'generate',
+      '--quiet',
+      '--add-include-path=@0@'.format(meson.current_build_dir() / '../pango'),
+      '--config', pangofc_toml,
+      '--output-dir=@OUTPUT@',
+      '--no-namespace-dir',
+      '--content-dir=@0@'.format(meson.current_source_dir()),
+      '@INPUT@',
+    ],
+    depend_files: [ pangofc_toml, 'pango-name.png' ],
+    build_by_default: true,
+  )
+endif
diff --git a/docs/pango.toml b/docs/pango.toml.in
similarity index 98%
rename from docs/pango.toml
rename to docs/pango.toml.in
index 23d46b22..986bfc8b 100644
--- a/docs/pango.toml
+++ b/docs/pango.toml.in
@@ -1,6 +1,6 @@
 [library]
 namespace = "Pango"
-version = "1.0"
+version = "@PANGO_VERSION@"
 browse_url = "https://gitlab.gnome.org/GNOME/pango/";
 repository_url = "https://gitlab.gnome.org/GNOME/pango.git";
 website_url = "https://www.pango.org";
diff --git a/docs/pangocairo.toml b/docs/pangocairo.toml.in
similarity index 96%
rename from docs/pangocairo.toml
rename to docs/pangocairo.toml.in
index 23c076f8..2e0124e3 100644
--- a/docs/pangocairo.toml
+++ b/docs/pangocairo.toml.in
@@ -1,6 +1,6 @@
 [library]
 namespace = "PangoCairo"
-version = "1.0"
+version = "@PANGO_VERSION@"
 browse_url = "https://gitlab.gnome.org/GNOME/pango/";
 repository_url = "https://gitlab.gnome.org/GNOME/pango.git";
 website_url = "https://www.pango.org";
diff --git a/docs/pangofc.toml b/docs/pangofc.toml.in
similarity index 96%
rename from docs/pangofc.toml
rename to docs/pangofc.toml.in
index f41526bd..7acd5d72 100644
--- a/docs/pangofc.toml
+++ b/docs/pangofc.toml.in
@@ -1,6 +1,6 @@
 [library]
 namespace = "PangoFc"
-version = "1.0"
+version = "@PANGO_VERSION@"
 browse_url = "https://gitlab.gnome.org/GNOME/pango/";
 repository_url = "https://gitlab.gnome.org/GNOME/pango.git";
 website_url = "https://www.pango.org";
diff --git a/docs/pangoft2.toml b/docs/pangoft2.toml.in
similarity index 96%
rename from docs/pangoft2.toml
rename to docs/pangoft2.toml.in
index f3733253..43c0ca75 100644
--- a/docs/pangoft2.toml
+++ b/docs/pangoft2.toml.in
@@ -1,6 +1,6 @@
 [library]
 namespace = "PangoFT2"
-version = "1.0"
+version = "@PANGO_VERSION@"
 browse_url = "https://gitlab.gnome.org/GNOME/pango/";
 repository_url = "https://gitlab.gnome.org/GNOME/pango.git";
 website_url = "https://www.pango.org";
diff --git a/docs/pangoot.toml b/docs/pangoot.toml.in
similarity index 96%
rename from docs/pangoot.toml
rename to docs/pangoot.toml.in
index dc0eb091..581a4239 100644
--- a/docs/pangoot.toml
+++ b/docs/pangoot.toml.in
@@ -1,6 +1,6 @@
 [library]
 namespace = "PangoOT"
-version = "1.0"
+version = "@PANGO_VERSION@"
 browse_url = "https://gitlab.gnome.org/GNOME/pango/";
 repository_url = "https://gitlab.gnome.org/GNOME/pango.git";
 website_url = "https://www.pango.org";
diff --git a/docs/pangoxft.toml b/docs/pangoxft.toml.in
similarity index 96%
rename from docs/pangoxft.toml
rename to docs/pangoxft.toml.in
index 07901e26..241c0aa0 100644
--- a/docs/pangoxft.toml
+++ b/docs/pangoxft.toml.in
@@ -1,6 +1,6 @@
 [library]
 namespace = "PangoXft"
-version = "1.0"
+version = "@PANGO_VERSION@"
 browse_url = "https://gitlab.gnome.org/GNOME/pango/";
 repository_url = "https://gitlab.gnome.org/GNOME/pango.git";
 website_url = "https://www.pango.org";
diff --git a/docs/rects3.png b/docs/rects3.png
new file mode 100644
index 00000000..4817b7af
Binary files /dev/null and b/docs/rects3.png differ
diff --git a/meson.build b/meson.build
index 28d9c9ba..f9e63347 100644
--- a/meson.build
+++ b/meson.build
@@ -585,6 +585,10 @@ libsysprof_capture_dep = dependency('sysprof-capture-4',
 pango_conf.set('HAVE_SYSPROF', libsysprof_capture_dep.found())
 pango_deps += libsysprof_capture_dep
 
+gidocgen_dep = dependency('gi-docgen', version: '>= 2021.1',
+                          fallback: ['gi-docgen', 'dummy_dep'],
+                          required: get_option('gtk_doc'))
+
 gnome = import('gnome')
 pkgconfig = import('pkgconfig')
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]