gtk/docs/reference/meson.build

toml_conf = configuration_data()
toml_conf.set('version', meson.project_version())

gidocgen = find_program('gi-docgen', required: get_option('gtk_doc'), native: true)

gidocgen_common_args = [
  '--quiet',
  '--no-namespace-dir',
]

if get_option('werror')
  gidocgen_common_args += ['--fatal-warnings']
endif

docs_dir = gtk_datadir / 'doc'

if get_option('gtk_doc') and not build_gir
  error('API reference requires introspection.')
endif

subdir('gdk')
subdir('gsk')
subdir('gtk')
Generate GTK API reference(s) 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. 2021-02-10 13:41:53 +00:00			`toml_conf = configuration_data()`
			`toml_conf.set('version', meson.project_version())`

meson: Require gi-docgen when gtk_doc is required Fixes build with only `-Dgtk_doc=true` without `-Dintrospection=enabled`: Program gi-docgen found: NO Configuring gdk4.toml using configuration docs/reference/gdk/meson.build:13:2: ERROR: Tried to use not-found external program in "command" `introspection` is `auto` by default. The rest of the docs build is only contingent on `if get_option('gtk_doc')` so we should use the same restriction here. We check for `build_gir` below already, and the gi-docgen subproject itself does not need gobject-introspection so it's fine to do it like this. 2022-12-20 03:54:30 +00:00			`gidocgen = find_program('gi-docgen', required: get_option('gtk_doc'), native: true)`
Generate GTK API reference(s) 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. 2021-02-10 13:41:53 +00:00
build: Collect gi-docgen's common arguments And only enable `--fatal-warnings` if `-Dwerror` has been set, just like we do for the introspection data generation. 2021-11-01 13:00:51 +00:00			`gidocgen_common_args = [`
			`'--quiet',`
			`'--no-namespace-dir',`
			`]`

			`if get_option('werror')`
			`gidocgen_common_args += ['--fatal-warnings']`
			`endif`

Install documentation in the appropriate place We're already installing each reference into its own namespaced directory, so we don't need to add further path elements. Additionally, with the changes in: https://gitlab.gnome.org/GNOME/devhelp/-/merge_requests/20 https://gitlab.gnome.org/GNOME/gi-docgen/-/merge_requests/54 we can browse the GTK API references in DevHelp. 2021-04-07 13:57:31 +00:00			`docs_dir = gtk_datadir / 'doc'`
build: Install the API references We are building them, but not installing them. 2021-03-12 11:13:54 +00:00
build: Check that introspection is enabled for docs build 2021-08-29 00:47:34 +00:00			`if get_option('gtk_doc') and not build_gir`
			`error('API reference requires introspection.')`
			`endif`

build: Generate the API references (WIP) Still a work in progress. 2017-04-19 10:35:45 +00:00			`subdir('gdk')`
			`subdir('gsk')`
			`subdir('gtk')`