luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-10-31 16:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
7b5bcf62b8e1a2b1e031a044127bf5827e242273
glib/docs/reference/gio/meson.build

65 lines
1.6 KiB
Meson
Raw Normal View History

docs: Port the man pages from DocBook to reStructuredText So they are consistent with the way we’re building man pages in other projects, and because some people are allergic to XML. This changes the build-time dependencies from `xsltproc` to `rst2man`, and also takes the opportunity to change the `-Dman` Meson option from a boolean to a feature (so you should use `-Dman-pages={enabled,disabled}` now, rather than `-Dman={true,false}`). Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3037
2023-12-20 14:04:11 +00:00
if get_option('man-pages').enabled()
meson: Detect with-docs and with-man automatically By default, only build man pages and gtk-doc if the build-deps were found. To force-enable, pass -Dwith-docs=yes and -Dwith-man=yes. Also use a foreach loop for man pages instead of listing them all manually
2017-03-21 16:38:47 +05:30
manpages = ['gapplication', 'gio-querymodules', 'glib-compile-schemas',
'glib-compile-resources', 'gsettings', 'gresource', 'gdbus',
'gio', 'gdbus-codegen']
foreach page : manpages
custom_target(page + '-man',
docs: Port the man pages from DocBook to reStructuredText So they are consistent with the way we’re building man pages in other projects, and because some people are allergic to XML. This changes the build-time dependencies from `xsltproc` to `rst2man`, and also takes the opportunity to change the `-Dman` Meson option from a boolean to a feature (so you should use `-Dman-pages={enabled,disabled}` now, rather than `-Dman={true,false}`). Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3037
2023-12-20 14:04:11 +00:00
input: page + '.rst',
meson: Detect with-docs and with-man automatically By default, only build man pages and gtk-doc if the build-deps were found. To force-enable, pass -Dwith-docs=yes and -Dwith-man=yes. Also use a foreach loop for man pages instead of listing them all manually
2017-03-21 16:38:47 +05:30
output: page + '.1',
docs: Port the man pages from DocBook to reStructuredText So they are consistent with the way we’re building man pages in other projects, and because some people are allergic to XML. This changes the build-time dependencies from `xsltproc` to `rst2man`, and also takes the opportunity to change the `-Dman` Meson option from a boolean to a feature (so you should use `-Dman-pages={enabled,disabled}` now, rather than `-Dman={true,false}`). Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3037
2023-12-20 14:04:11 +00:00
command: [
rst2man,
rst2man_flags,
'@INPUT@',
],
capture: true,
meson: Detect with-docs and with-man automatically By default, only build man pages and gtk-doc if the build-deps were found. To force-enable, pass -Dwith-docs=yes and -Dwith-man=yes. Also use a foreach loop for man pages instead of listing them all manually
2017-03-21 16:38:47 +05:30
install: true,
docs: Set install_tag on man pages Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3037
2023-12-18 14:52:16 +00:00
install_dir: man1_dir,
install_tag: 'doc',
)
meson: Detect with-docs and with-man automatically By default, only build man pages and gtk-doc if the build-deps were found. To force-enable, pass -Dwith-docs=yes and -Dwith-man=yes. Also use a foreach loop for man pages instead of listing them all manually
2017-03-21 16:38:47 +05:30
endforeach
meson: Build all docs
2016-12-07 05:28:33 -05:00
endif
docs: Add initial support for using gi-docgen for docs The files here are copied from the docs-gtk-org branch of gtk. This adds gi-docgen to the CI Dockerfiles and ensures the new versions (including the OS upgrades from the previous commit) are used during CI. Helps: #3037
2023-10-09 23:04:21 +01:00
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>
2024-01-11 15:39:51 +00:00
if get_option('documentation') and enable_gir
expand_content_files = [
'dbus-error.md',
'dbus-introspection.md',
'dbus-name-owning.md',
'dbus-name-watching.md',
'dbus-utils.md',
'error.md',
'file-attributes.md',
'io-scheduler.md',
'menu-exporter.md',
'migrating-gconf.md',
'migrating-gdbus.md',
'migrating-gnome-vfs.md',
'migrating-posix.md',
'networking.md',
'overview.md',
'pollable-utils.md',
'tls-overview.md',
'unix-mounts.md',
]
docs: Add initial support for using gi-docgen for docs The files here are copied from the docs-gtk-org branch of gtk. This adds gi-docgen to the CI Dockerfiles and ensures the new versions (including the OS upgrades from the previous commit) are used during CI. Helps: #3037
2023-10-09 23:04:21 +01:00
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>
2024-01-11 15:39:51 +00:00
gio_toml = configure_file(input: 'gio.toml.in', output: 'gio.toml', configuration: toml_conf)
docs: Add initial support for using gi-docgen for docs The files here are copied from the docs-gtk-org branch of gtk. This adds gi-docgen to the CI Dockerfiles and ensures the new versions (including the OS upgrades from the previous commit) are used during CI. Helps: #3037
2023-10-09 23:04:21 +01:00
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>
2024-01-11 15:39:51 +00:00
custom_target('gio-docs',
input: [ gio_toml, gio_gir[0] ],
output: 'gio',
command: [
gidocgen,
'generate',
gidocgen_common_args,
'--config=@INPUT0@',
'--output-dir=@OUTPUT@',
'--content-dir=@0@'.format(meson.current_source_dir()),
'@INPUT1@',
],
build_by_default: true,
depend_files: expand_content_files,
install: true,
install_dir: docs_dir,
install_tag: 'doc',
)
endif
Reference in New Issue Copy Permalink