luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-20 15:48:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

meson: wrap html documentation generation with gtk_doc option

Browse Source 
By default, if a host environment has the `rst2html5` application
available, builds will automatically perform some HTML documentation
generation from the documentation's glib reference content (e.g.
creating `gvariant-specification-1.0.html`). The creation of this
documentation is not required for all use cases.

This commit tweaks the building of the HTML-based GLIB specification
document to be guarded by `gtk_doc`.

Signed-off-by: James Knight <james.d.knight@live.com>
This commit is contained in:
James Knight
2023-04-27 20:23:30 -04:00
parent c176fcf2eb
commit 0fa17ec3c7
1 changed files with 30 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/reference/glib/meson.build
View File

@@ -113,35 +113,37 @@ if get_option('man')
endforeach endforeach
endif endif
# GVariant specification is currently standalone if get_option('gtk_doc')
rst2html5 = find_program('rst2html5', 'rst2html5.py', required: false) # GVariant specification is currently standalone
rst2html5 = find_program('rst2html5', 'rst2html5.py', required: false)
if rst2html5.found() if rst2html5.found()
spec_path = glib_datadir / 'doc' / 'glib-2.0' spec_path = glib_datadir / 'doc' / 'glib-2.0'
figures = files( figures = files(
'gvariant-byte-boundaries.svg', 'gvariant-byte-boundaries.svg',
'gvariant-integer-and-string-structure.svg', 'gvariant-integer-and-string-structure.svg',
'gvariant-integer-array.svg', 'gvariant-integer-array.svg',
'gvariant-string-array.svg', 'gvariant-string-array.svg',
) )
custom_target('gvariant-specification-1.0', custom_target('gvariant-specification-1.0',
input: 'gvariant-specification-1.0.rst', input: 'gvariant-specification-1.0.rst',
output: 'gvariant-specification-1.0.html', output: 'gvariant-specification-1.0.html',
command: [ command: [
rst2html5, rst2html5,
'@INPUT@', '@INPUT@',
], ],
capture: true, capture: true,
install: true, install: true,
install_dir: spec_path, install_dir: spec_path,
install_tag: 'doc', install_tag: 'doc',
depend_files: figures, depend_files: figures,
) )
install_data(figures, install_data(figures,
install_dir : spec_path, install_dir : spec_path,
install_tag : 'doc', install_tag : 'doc',
) )
endif endif
endif