dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
gimp/devel-docs/g-ir-docs/meson.build

136 lines
5.5 KiB
Meson
Raw Normal View History

devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
foreach lang : [ 'python', 'gjs' ]
devel-docs: Introspected Python libgimp and libgimpui docs generation. Based on the proposed process proposed by Akkana Peck. Thanks Akk! For now, it's only in the meson build, which is fairly terrible to use as soon as we do custom build rules. Here are the list of issues: - meson does not allow building in subdir (issue 2320 on meson tracker). Sure I could make several subdirs with meson in them. But here the future goal would be to be able to generate docs for other introspected languages, and maybe also other output formats (epub or whatnot). For this, since these are basically the same commands which are used, the best practice would be to have loops generating one target per language/format combination, reusing code rather than ugly copy-pasting in subdirectories' meson files). - custom_target() requires the output parameter to be the complete list of generated files. But we have more than a thousand of them. It's not practical. Maybe we could try to find a way to generate the list from the contents of the .def files which are already exhaustive and exact. - Install also requires the output list to be complete. - I temporarily have these docs not generated by default (because the gtk-doc option is already crazy slow as it is, making meson near unusable for development if it's enabled). If you want to generate the docs, the commands are as following (yeah I don't understand what the target names are for since meson does not actually create targets with these names, so we have to use fake output names instead): > ninja devel-docs/g-ir-docs/Gimp-python-html > ninja devel-docs/g-ir-docs/GimpUi-python-html
2021-01-21 23:31:35 +08:00
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
# XXX meson does not allow building into subdir:
# https://github.com/mesonbuild/meson/issues/2320
# Otherwise I could use '-o', '@OUTDIR@' into following commands if
# the `output` was subdir-able.
gir_docs_dir = custom_target('g-ir-docs-' + lang + '-dir',
depends: [ libgimp_gir, libgimpui_gir ],
input: [ ],
output: [ 'gir-' + lang + '-dirs' ],
command: [
'mkdir', '-p',
'@OUTDIR@' + '/pages/' + lang + '/GimpUi-' + gimp_api_version,
'@OUTDIR@' + '/pages/' + lang + '/Gimp-' + gimp_api_version,
'@OUTDIR@' + '/html/' + lang + '/GimpUi-' + gimp_api_version,
'@OUTDIR@' + '/html/' + lang + '/Gimp-' + gimp_api_version
],
build_by_default: true)
devel-docs: Introspected Python libgimp and libgimpui docs generation. Based on the proposed process proposed by Akkana Peck. Thanks Akk! For now, it's only in the meson build, which is fairly terrible to use as soon as we do custom build rules. Here are the list of issues: - meson does not allow building in subdir (issue 2320 on meson tracker). Sure I could make several subdirs with meson in them. But here the future goal would be to be able to generate docs for other introspected languages, and maybe also other output formats (epub or whatnot). For this, since these are basically the same commands which are used, the best practice would be to have loops generating one target per language/format combination, reusing code rather than ugly copy-pasting in subdirectories' meson files). - custom_target() requires the output parameter to be the complete list of generated files. But we have more than a thousand of them. It's not practical. Maybe we could try to find a way to generate the list from the contents of the .def files which are already exhaustive and exact. - Install also requires the output list to be complete. - I temporarily have these docs not generated by default (because the gtk-doc option is already crazy slow as it is, making meson near unusable for development if it's enabled). If you want to generate the docs, the commands are as following (yeah I don't understand what the target names are for since meson does not actually create targets with these names, so we have to use fake output names instead): > ninja devel-docs/g-ir-docs/Gimp-python-html > ninja devel-docs/g-ir-docs/GimpUi-python-html
2021-01-21 23:31:35 +08:00
Issue #7685: g-ir-doc-tool produces broken XML. To work around the issue, I just wrote a stupid sed script. Of course, it means that if we encounter again the issue on some other docs, we'll have to update it. In other words, it's neither robust nor a proper long-term fix. Just a temporary hack. See: https://gitlab.gnome.org/GNOME/gobject-introspection/-/issues/425 Also fixing this issue, I encountered another bug, this time in meson, which changes backslashes in slashes on 'command' arguments, in a completely uninvited manner! The only workaround to this is apparently to call an external script, which is ridiculous for such a basic stuff. But well… here is why I implement this with a script, instead of directly calling sed in the meson 'command'. See: https://github.com/mesonbuild/meson/issues/1564
2022-03-27 00:49:45 +08:00
## Gimp Module ##
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
# XXX `output` is bogus. g-ir-doc-tool produces a lot of output,
# basically one page per public symbol, which is more than 1000 so
# it's not usable. Since custom_target() requires an 'output', I could
# just set one output such as 'index.page` as a trick, but since we
# have another issue on subdir anyway (cf. above), I use some bogus
# file instead. The fact the bogus file is not even created does not
# even seem to be a problem for meson.
# Moreover I realized that the targets listed by ninja are only the
# output files (not the target name), so I basically ends up using
# this field to create understandable names).
gir_docs_pages = custom_target('g-ir-Gimp-' + lang + '-pages',
depends: [ gir_docs_dir, libgimp_gir ],
input: [ libgimp_gir[0] ],
output: [ 'Gimp-' + lang + '-pages' ],
command: [
gir_doc_tool,
'-I', prefix / 'share/gir-1.0/',
meson: fix warnings of deprecated features. Now that we bumped our meson requirement, meson is complaining about several features now deprecated even in the minimum required meson version: s/meson.source_root/meson.project_source_root/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': meson.source_root. use meson.project_source_root() or meson.global_source_root() instead. s/meson.build_root/meson.project_build_root/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': meson.build_root. use meson.project_build_root() or meson.global_build_root() instead. Fixing using path() on xdg_email and python ExternalProgram variables: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.55.0': ExternalProgram.path. use ExternalProgram.full_path() instead s/get_pkgconfig_variable *(\([^)]*\))/get_variable(pkgconfig: \1)/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': dependency.get_pkgconfig_variable. use dependency.get_variable(pkgconfig : ...) instead
2022-08-31 07:07:27 +08:00
'-I', meson.project_build_root() / 'libgimp',
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
'--language=' + lang,
'-o', '@OUTDIR@' + '/pages/' + lang + '/Gimp-' + gimp_api_version,
meson: fix warnings of deprecated features. Now that we bumped our meson requirement, meson is complaining about several features now deprecated even in the minimum required meson version: s/meson.source_root/meson.project_source_root/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': meson.source_root. use meson.project_source_root() or meson.global_source_root() instead. s/meson.build_root/meson.project_build_root/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': meson.build_root. use meson.project_build_root() or meson.global_build_root() instead. Fixing using path() on xdg_email and python ExternalProgram variables: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.55.0': ExternalProgram.path. use ExternalProgram.full_path() instead s/get_pkgconfig_variable *(\([^)]*\))/get_variable(pkgconfig: \1)/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': dependency.get_pkgconfig_variable. use dependency.get_variable(pkgconfig : ...) instead
2022-08-31 07:07:27 +08:00
meson.project_build_root() / '@INPUT@'
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
],
build_by_default: true)
devel-docs: Introspected Python libgimp and libgimpui docs generation. Based on the proposed process proposed by Akkana Peck. Thanks Akk! For now, it's only in the meson build, which is fairly terrible to use as soon as we do custom build rules. Here are the list of issues: - meson does not allow building in subdir (issue 2320 on meson tracker). Sure I could make several subdirs with meson in them. But here the future goal would be to be able to generate docs for other introspected languages, and maybe also other output formats (epub or whatnot). For this, since these are basically the same commands which are used, the best practice would be to have loops generating one target per language/format combination, reusing code rather than ugly copy-pasting in subdirectories' meson files). - custom_target() requires the output parameter to be the complete list of generated files. But we have more than a thousand of them. It's not practical. Maybe we could try to find a way to generate the list from the contents of the .def files which are already exhaustive and exact. - Install also requires the output list to be complete. - I temporarily have these docs not generated by default (because the gtk-doc option is already crazy slow as it is, making meson near unusable for development if it's enabled). If you want to generate the docs, the commands are as following (yeah I don't understand what the target names are for since meson does not actually create targets with these names, so we have to use fake output names instead): > ninja devel-docs/g-ir-docs/Gimp-python-html > ninja devel-docs/g-ir-docs/GimpUi-python-html
2021-01-21 23:31:35 +08:00
Issue #7685: g-ir-doc-tool produces broken XML. To work around the issue, I just wrote a stupid sed script. Of course, it means that if we encounter again the issue on some other docs, we'll have to update it. In other words, it's neither robust nor a proper long-term fix. Just a temporary hack. See: https://gitlab.gnome.org/GNOME/gobject-introspection/-/issues/425 Also fixing this issue, I encountered another bug, this time in meson, which changes backslashes in slashes on 'command' arguments, in a completely uninvited manner! The only workaround to this is apparently to call an external script, which is ridiculous for such a basic stuff. But well… here is why I implement this with a script, instead of directly calling sed in the meson 'command'. See: https://github.com/mesonbuild/meson/issues/1564
2022-03-27 00:49:45 +08:00
# This step is completely an ugly workaround for 2 tool issues. The
# first issue is that g-ir-doc-tool generates invalid XML by not
# transforming less-than signs into entities. So I am special-casing
# the one API documentation where we need to write a less-than (it will
# need to be updated if this happens again).
# See GIMP issue #7685.
# The second issue is in meson itself which transforms backslash into
# slashes preventing to write most basic regexp in a 'command'. For
# this reason, I need to add the sed command as an external script.
# See meson issue #1564.
docs_pages_fix_sh = find_program('docs_pages_fix.sh')
gir_docs_pages_fix = custom_target('g-ir-Gimp-' + lang + '-pages-fix',
input: [ gir_docs_pages ],
output: [ 'Gimp-' + lang + '-pages-fix' ],
command: [
docs_pages_fix_sh,
'@OUTDIR@' + '/pages/' + lang + '/Gimp-' + gimp_api_version + '/Gimp.Procedure.add_menu_path.page',
devel-docs: fix again This will work around such errors from the g-ir-doc build: > devel-docs/g-ir-docs/pages/python/Gimp-3.0/Gimp.checks_get_colors.page:46: parser error : EntityRef: expecting ';' > gimp_checks_get_colors (gimp_check_type (), &color1, &color2); > ^ Similar to commit 7123b6c466, it cannot really be considered a proper fix, barely a workaround for g-ir-doc-tool not even able to produce valid XML. Here we have ampersands which it should have espaced into XML entities. Anyway this will do for now (until we just decide to drop the g-ir-docs tools?).
2022-05-15 00:47:53 +08:00
'@OUTDIR@' + '/pages/' + lang + '/Gimp-' + gimp_api_version + '/Gimp.checks_get_colors.page',
Issue #7685: g-ir-doc-tool produces broken XML. To work around the issue, I just wrote a stupid sed script. Of course, it means that if we encounter again the issue on some other docs, we'll have to update it. In other words, it's neither robust nor a proper long-term fix. Just a temporary hack. See: https://gitlab.gnome.org/GNOME/gobject-introspection/-/issues/425 Also fixing this issue, I encountered another bug, this time in meson, which changes backslashes in slashes on 'command' arguments, in a completely uninvited manner! The only workaround to this is apparently to call an external script, which is ridiculous for such a basic stuff. But well… here is why I implement this with a script, instead of directly calling sed in the meson 'command'. See: https://github.com/mesonbuild/meson/issues/1564
2022-03-27 00:49:45 +08:00
],
build_by_default: true)
devel-docs: Introspected Python libgimp and libgimpui docs generation. Based on the proposed process proposed by Akkana Peck. Thanks Akk! For now, it's only in the meson build, which is fairly terrible to use as soon as we do custom build rules. Here are the list of issues: - meson does not allow building in subdir (issue 2320 on meson tracker). Sure I could make several subdirs with meson in them. But here the future goal would be to be able to generate docs for other introspected languages, and maybe also other output formats (epub or whatnot). For this, since these are basically the same commands which are used, the best practice would be to have loops generating one target per language/format combination, reusing code rather than ugly copy-pasting in subdirectories' meson files). - custom_target() requires the output parameter to be the complete list of generated files. But we have more than a thousand of them. It's not practical. Maybe we could try to find a way to generate the list from the contents of the .def files which are already exhaustive and exact. - Install also requires the output list to be complete. - I temporarily have these docs not generated by default (because the gtk-doc option is already crazy slow as it is, making meson near unusable for development if it's enabled). If you want to generate the docs, the commands are as following (yeah I don't understand what the target names are for since meson does not actually create targets with these names, so we have to use fake output names instead): > ninja devel-docs/g-ir-docs/Gimp-python-html > ninja devel-docs/g-ir-docs/GimpUi-python-html
2021-01-21 23:31:35 +08:00
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
gir_docs_cache = custom_target('g-ir-Gimp-' + lang + '-cache',
Issue #7685: g-ir-doc-tool produces broken XML. To work around the issue, I just wrote a stupid sed script. Of course, it means that if we encounter again the issue on some other docs, we'll have to update it. In other words, it's neither robust nor a proper long-term fix. Just a temporary hack. See: https://gitlab.gnome.org/GNOME/gobject-introspection/-/issues/425 Also fixing this issue, I encountered another bug, this time in meson, which changes backslashes in slashes on 'command' arguments, in a completely uninvited manner! The only workaround to this is apparently to call an external script, which is ridiculous for such a basic stuff. But well… here is why I implement this with a script, instead of directly calling sed in the meson 'command'. See: https://github.com/mesonbuild/meson/issues/1564
2022-03-27 00:49:45 +08:00
input: [ gir_docs_pages_fix ],
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
output: [ 'Gimp-' + lang + '-cache' ],
command: [
yelp_build, 'cache',
'-o', '@OUTDIR@' + '/pages/' + lang + '/Gimp-' + gimp_api_version + '/index.cache',
'@OUTDIR@' + '/pages/' + lang + '/Gimp-' + gimp_api_version,
],
build_by_default: true)
devel-docs: Introspected Python libgimp and libgimpui docs generation. Based on the proposed process proposed by Akkana Peck. Thanks Akk! For now, it's only in the meson build, which is fairly terrible to use as soon as we do custom build rules. Here are the list of issues: - meson does not allow building in subdir (issue 2320 on meson tracker). Sure I could make several subdirs with meson in them. But here the future goal would be to be able to generate docs for other introspected languages, and maybe also other output formats (epub or whatnot). For this, since these are basically the same commands which are used, the best practice would be to have loops generating one target per language/format combination, reusing code rather than ugly copy-pasting in subdirectories' meson files). - custom_target() requires the output parameter to be the complete list of generated files. But we have more than a thousand of them. It's not practical. Maybe we could try to find a way to generate the list from the contents of the .def files which are already exhaustive and exact. - Install also requires the output list to be complete. - I temporarily have these docs not generated by default (because the gtk-doc option is already crazy slow as it is, making meson near unusable for development if it's enabled). If you want to generate the docs, the commands are as following (yeah I don't understand what the target names are for since meson does not actually create targets with these names, so we have to use fake output names instead): > ninja devel-docs/g-ir-docs/Gimp-python-html > ninja devel-docs/g-ir-docs/GimpUi-python-html
2021-01-21 23:31:35 +08:00
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
gir_docs_html = custom_target('g-ir-Gimp-' + lang + '-html',
input: [ gir_docs_cache ],
output: [ 'Gimp-' + lang + '-html' ],
# TODO: `output` needs to be complete for installation to work. So
# we need to figure out how to install the generated files (listing
# all of them is a crazy idea, but maybe we can generate the
# expected list somehow? Maybe even using the .def file which is
# already an exhaustive listing would be a good idea?
# Also where should we install exactly?
#install_dir: prefix / gimpdatadir / 'g-ir-docs/html/' + lang + '/Gimp',
#install: true,
command: [
'yelp-build', 'html',
'-o', '@OUTDIR@' + '/html/' + lang + '/Gimp-' + gimp_api_version,
'@OUTDIR@' + '/pages/' + lang + '/Gimp-' + gimp_api_version,
],
build_by_default: true)
devel-docs: Introspected Python libgimp and libgimpui docs generation. Based on the proposed process proposed by Akkana Peck. Thanks Akk! For now, it's only in the meson build, which is fairly terrible to use as soon as we do custom build rules. Here are the list of issues: - meson does not allow building in subdir (issue 2320 on meson tracker). Sure I could make several subdirs with meson in them. But here the future goal would be to be able to generate docs for other introspected languages, and maybe also other output formats (epub or whatnot). For this, since these are basically the same commands which are used, the best practice would be to have loops generating one target per language/format combination, reusing code rather than ugly copy-pasting in subdirectories' meson files). - custom_target() requires the output parameter to be the complete list of generated files. But we have more than a thousand of them. It's not practical. Maybe we could try to find a way to generate the list from the contents of the .def files which are already exhaustive and exact. - Install also requires the output list to be complete. - I temporarily have these docs not generated by default (because the gtk-doc option is already crazy slow as it is, making meson near unusable for development if it's enabled). If you want to generate the docs, the commands are as following (yeah I don't understand what the target names are for since meson does not actually create targets with these names, so we have to use fake output names instead): > ninja devel-docs/g-ir-docs/Gimp-python-html > ninja devel-docs/g-ir-docs/GimpUi-python-html
2021-01-21 23:31:35 +08:00
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
## GimpUi module ##
devel-docs: Introspected Python libgimp and libgimpui docs generation. Based on the proposed process proposed by Akkana Peck. Thanks Akk! For now, it's only in the meson build, which is fairly terrible to use as soon as we do custom build rules. Here are the list of issues: - meson does not allow building in subdir (issue 2320 on meson tracker). Sure I could make several subdirs with meson in them. But here the future goal would be to be able to generate docs for other introspected languages, and maybe also other output formats (epub or whatnot). For this, since these are basically the same commands which are used, the best practice would be to have loops generating one target per language/format combination, reusing code rather than ugly copy-pasting in subdirectories' meson files). - custom_target() requires the output parameter to be the complete list of generated files. But we have more than a thousand of them. It's not practical. Maybe we could try to find a way to generate the list from the contents of the .def files which are already exhaustive and exact. - Install also requires the output list to be complete. - I temporarily have these docs not generated by default (because the gtk-doc option is already crazy slow as it is, making meson near unusable for development if it's enabled). If you want to generate the docs, the commands are as following (yeah I don't understand what the target names are for since meson does not actually create targets with these names, so we have to use fake output names instead): > ninja devel-docs/g-ir-docs/Gimp-python-html > ninja devel-docs/g-ir-docs/GimpUi-python-html
2021-01-21 23:31:35 +08:00
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
gir_ui_docs_pages = custom_target('g-ir-GimpUi-' + lang + '-pages',
depends: [ gir_docs_dir, libgimpui_gir ],
input: [ libgimpui_gir[0] ],
output: [ 'GimpUi-' + lang + '-pages' ],
command: [
gir_doc_tool,
'-I', prefix / 'share/gir-1.0/',
meson: fix warnings of deprecated features. Now that we bumped our meson requirement, meson is complaining about several features now deprecated even in the minimum required meson version: s/meson.source_root/meson.project_source_root/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': meson.source_root. use meson.project_source_root() or meson.global_source_root() instead. s/meson.build_root/meson.project_build_root/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': meson.build_root. use meson.project_build_root() or meson.global_build_root() instead. Fixing using path() on xdg_email and python ExternalProgram variables: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.55.0': ExternalProgram.path. use ExternalProgram.full_path() instead s/get_pkgconfig_variable *(\([^)]*\))/get_variable(pkgconfig: \1)/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': dependency.get_pkgconfig_variable. use dependency.get_variable(pkgconfig : ...) instead
2022-08-31 07:07:27 +08:00
'-I', meson.project_build_root() / 'libgimp',
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
'--language=' + lang,
'-o', '@OUTDIR@' + '/pages/' + lang + '/GimpUi-' + gimp_api_version,
meson: fix warnings of deprecated features. Now that we bumped our meson requirement, meson is complaining about several features now deprecated even in the minimum required meson version: s/meson.source_root/meson.project_source_root/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': meson.source_root. use meson.project_source_root() or meson.global_source_root() instead. s/meson.build_root/meson.project_build_root/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': meson.build_root. use meson.project_build_root() or meson.global_build_root() instead. Fixing using path() on xdg_email and python ExternalProgram variables: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.55.0': ExternalProgram.path. use ExternalProgram.full_path() instead s/get_pkgconfig_variable *(\([^)]*\))/get_variable(pkgconfig: \1)/ to fix: > WARNING: Project targets '>=0.56.0' but uses feature deprecated since '0.56.0': dependency.get_pkgconfig_variable. use dependency.get_variable(pkgconfig : ...) instead
2022-08-31 07:07:27 +08:00
meson.project_build_root() / '@INPUT@'
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
],
build_by_default: true)
devel-docs: Introspected Python libgimp and libgimpui docs generation. Based on the proposed process proposed by Akkana Peck. Thanks Akk! For now, it's only in the meson build, which is fairly terrible to use as soon as we do custom build rules. Here are the list of issues: - meson does not allow building in subdir (issue 2320 on meson tracker). Sure I could make several subdirs with meson in them. But here the future goal would be to be able to generate docs for other introspected languages, and maybe also other output formats (epub or whatnot). For this, since these are basically the same commands which are used, the best practice would be to have loops generating one target per language/format combination, reusing code rather than ugly copy-pasting in subdirectories' meson files). - custom_target() requires the output parameter to be the complete list of generated files. But we have more than a thousand of them. It's not practical. Maybe we could try to find a way to generate the list from the contents of the .def files which are already exhaustive and exact. - Install also requires the output list to be complete. - I temporarily have these docs not generated by default (because the gtk-doc option is already crazy slow as it is, making meson near unusable for development if it's enabled). If you want to generate the docs, the commands are as following (yeah I don't understand what the target names are for since meson does not actually create targets with these names, so we have to use fake output names instead): > ninja devel-docs/g-ir-docs/Gimp-python-html > ninja devel-docs/g-ir-docs/GimpUi-python-html
2021-01-21 23:31:35 +08:00
devel-docs: generate both gjs (Javascript) and Python API docs. Apparently g-ir-doc-tool does not support other language than C, Python and gjs right now (in particular neither Lua nor Vala bindings).
2021-01-30 01:04:20 +08:00
gir_ui_docs_cache = custom_target('g-ir-GimpUi-' + lang + '-cache',
input: [ gir_ui_docs_pages ],
output: [ 'GimpUi-' + lang + '-cache' ],
command: [
yelp_build, 'cache',
'-o', '@OUTDIR@' + '/pages/' + lang + '/GimpUi-' + gimp_api_version + '/index.cache',
'@OUTDIR@' + '/pages/' + lang + '/GimpUi-' + gimp_api_version,
],
build_by_default: true)
gir_ui_docs_html = custom_target('g-ir-GimpUi-' + lang + '-html',
input: [ gir_ui_docs_cache ],
output: [ 'GimpUi-' + lang + '-html' ],
#install_dir: prefix / gimpdatadir / 'g-ir-docs/html/' + lang + '/GimpUi',
#install: true,
command: [
'yelp-build', 'html',
'-o', '@OUTDIR@' + '/html/' + lang + '/GimpUi-' + gimp_api_version,
'@OUTDIR@' + '/pages/' + lang + '/GimpUi-' + gimp_api_version,
],
build_by_default: true)
endforeach
devel-docs: Introspected Python libgimp and libgimpui docs generation. Based on the proposed process proposed by Akkana Peck. Thanks Akk! For now, it's only in the meson build, which is fairly terrible to use as soon as we do custom build rules. Here are the list of issues: - meson does not allow building in subdir (issue 2320 on meson tracker). Sure I could make several subdirs with meson in them. But here the future goal would be to be able to generate docs for other introspected languages, and maybe also other output formats (epub or whatnot). For this, since these are basically the same commands which are used, the best practice would be to have loops generating one target per language/format combination, reusing code rather than ugly copy-pasting in subdirectories' meson files). - custom_target() requires the output parameter to be the complete list of generated files. But we have more than a thousand of them. It's not practical. Maybe we could try to find a way to generate the list from the contents of the .def files which are already exhaustive and exact. - Install also requires the output list to be complete. - I temporarily have these docs not generated by default (because the gtk-doc option is already crazy slow as it is, making meson near unusable for development if it's enabled). If you want to generate the docs, the commands are as following (yeah I don't understand what the target names are for since meson does not actually create targets with these names, so we have to use fake output names instead): > ninja devel-docs/g-ir-docs/Gimp-python-html > ninja devel-docs/g-ir-docs/GimpUi-python-html
2021-01-21 23:31:35 +08:00
devel-docs, meson: g-ir-doc option to generate introspected API docs. Similar to the --enable-g-ir-doc option I just added on autotools. Also separate this option from gtk-doc as it is unrelated (not everything under devel-docs is related to gtk-doc!).
2021-01-29 23:51:47 +08:00
## TODO: a unit test using yelp-check would be useful.