docs: Allow building man pages without the reference documentation

Now that the reference documentation uses gi-docgen, it's more
troublesome to generate in less standard build scenarios like
cross-compiling.

In distributions like Debian, reference documentation is generally
packaged separately (in libglib2.0-doc in Debian's case), but man pages
are generally packaged alongside the executables themselves (in the
libglib2.0-bin and libglib2.0-dev-bin packages, in Debian's case). We
can exclude the reference documentation when cross-compiling, but ideally
we would like the man pages to still be built, so that a cross-compiled
libglib2.0-bin or libglib2.0-dev-bin package has the same content as a
native build.

Signed-off-by: Simon McVittie <smcv@debian.org>
This commit is contained in:
Simon McVittie 2024-01-11 15:39:51 +00:00 committed by Simon McVittie
parent 38f5ba3c2f
commit aa28326b87
6 changed files with 191 additions and 181 deletions

View File

@ -19,6 +19,7 @@ if get_option('man-pages').enabled()
endforeach endforeach
endif endif
if get_option('documentation') and enable_gir
expand_content_files = [ expand_content_files = [
'dbus-error.md', 'dbus-error.md',
'dbus-introspection.md', 'dbus-introspection.md',
@ -60,3 +61,4 @@ custom_target('gio-docs',
install_dir: docs_dir, install_dir: docs_dir,
install_tag: 'doc', install_tag: 'doc',
) )
endif

View File

@ -1,3 +1,4 @@
if get_option('documentation') and enable_gir
girepository_toml = configure_file( girepository_toml = configure_file(
input: 'girepository.toml.in', input: 'girepository.toml.in',
output: 'girepository.toml', output: 'girepository.toml',
@ -21,3 +22,4 @@ custom_target('girepository-docs',
], ],
build_by_default: true, build_by_default: true,
) )
endif

View File

@ -53,6 +53,7 @@ if get_option('documentation')
endif endif
endif endif
if get_option('documentation') and enable_gir
expand_content_files = [ expand_content_files = [
'atomic.md', 'atomic.md',
'base64.md', 'base64.md',
@ -117,3 +118,4 @@ custom_target('glib-docs',
install_dir: docs_dir, install_dir: docs_dir,
install_tag: 'doc', install_tag: 'doc',
) )
endif

View File

@ -1,3 +1,4 @@
if get_option('documentation') and enable_gir
expand_content_files = [ expand_content_files = [
'modules.md', 'modules.md',
] ]
@ -22,3 +23,4 @@ custom_target('gmodule-docs',
install_dir: docs_dir, install_dir: docs_dir,
install_tag: 'doc', install_tag: 'doc',
) )
endif

View File

@ -17,6 +17,7 @@ if get_option('man-pages').enabled()
endforeach endforeach
endif endif
if get_option('documentation') and enable_gir
expand_content_files = [ expand_content_files = [
'boxed.md', 'boxed.md',
'concepts.md', 'concepts.md',
@ -49,3 +50,4 @@ custom_target('gobject-docs',
install_dir: docs_dir, install_dir: docs_dir,
install_tag: 'doc', install_tag: 'doc',
) )
endif

View File

@ -16,10 +16,10 @@ if get_option('documentation') and enable_gir
] ]
docs_dir = glib_datadir / 'doc' / 'glib-2.0' docs_dir = glib_datadir / 'doc' / 'glib-2.0'
endif
subdir('glib') subdir('glib')
subdir('gmodule') subdir('gmodule')
subdir('gobject') subdir('gobject')
subdir('gio') subdir('gio')
subdir('girepository') subdir('girepository')
endif