Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adapt to GLib 2.79 documentation #612

Merged
merged 2 commits into from
Jan 29, 2024
Merged

Adapt to GLib 2.79 documentation #612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d28090
build: Move computing gtk-doc module paths to the check place
ppisar Jan 26, 2024
29c339a
doc: Adapt GLib documentation path to GLib 2.79.0
ppisar Jan 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions meson.build
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,23 +67,27 @@ sed = find_program('sed')
test = find_program('test')

with_docs = get_option('with_docs')
gtk_doc_referred_paths = []
if with_docs
gtkdoc = dependency('gtk-doc')
glib_docpath = join_paths(glib_prefix, 'share', 'gtk-doc', 'html')

glib_index_path = join_paths(glib_docpath, 'glib/index.html')
ret = run_command ([test, '-e', glib_index_path],
check: false)
if ret.returncode() != 0
error('Missing documentation for GLib: @0@'.format(glib_index_path))
if glib.version().version_compare('<2.79.0')
glib_docpath = join_paths(glib_prefix, 'share', 'gtk-doc', 'html')
else
glib_docpath = join_paths(glib_prefix, 'share', 'doc', 'glib-2.0')
warning('glib >= 2.79.0 documention might not be properly referred from libmodulemd documentation.')
endif

gobject_index_path = join_paths(glib_docpath, 'gobject/index.html')
ret = run_command ([test, '-e', gobject_index_path],
check: false)
if ret.returncode() != 0
error('Missing documentation for GObject: @0@'.format(gobject_index_path))
endif
foreach referred_module : [ 'glib', 'gobject' ]
doc_module_path = join_paths(glib_docpath, referred_module)
doc_index_file = join_paths(doc_module_path, 'index.html')
ret = run_command ([test, '-e', doc_index_file],
check: false)
if ret.returncode() != 0
error('Missing GTK documentation for @0@: @1@'.format(referred_module, doc_index_file))
endif
gtk_doc_referred_paths += [ doc_module_path ]
endforeach
endif

# Keep with_manpages option a tristate feature for backward compatibility.
Expand Down Expand Up @@ -198,6 +202,7 @@ summary({'prefix': get_option('prefix'),
'datadir': get_option('datadir'),
'Python 2 GObject Overrides': gobject_overrides_dir_py2,
'Python 3 GObject Overrides': gobject_overrides_dir_py3,
'GTK-Doc Referred Paths': gtk_doc_referred_paths,
}, section: 'Directories')

summary({'Custom Python': get_option('python_name'),
Expand Down
9 changes: 5 additions & 4 deletions modulemd/meson.build
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,10 @@ configure_file(
# --- Documenatation --- #

if with_docs
fixxref_args = []
foreach path : gtk_doc_referred_paths
fixxref_args += [ '--extra-dir=@0@'.format(path) ]
endforeach
gnome.gtkdoc(
'modulemd-2.0',
install_dir: 'modulemd-2.0',
Expand All @@ -265,10 +269,7 @@ if with_docs
dependencies : [
modulemd_dep,
],
fixxref_args: [
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')),
'--extra-dir=@0@'.format(join_paths(glib_docpath, 'gobject')),
],
fixxref_args: [ fixxref_args ],
install : true,
)
endif
Expand Down
Loading