docs: Copy all images to output folder
authorXavi Artigas <xavierartigas@yahoo.es>
Mon, 18 Nov 2019 14:20:38 +0000 (15:20 +0100)
committerJongmin Lee <jm105.lee@samsung.com>
Tue, 19 Nov 2019 21:28:19 +0000 (06:28 +0900)
Summary:
Doxygen only copies to the output folder ("html") images included through
the \image tag. However, we have several images included using \htmlonly
blocks with <img> tags inside, which also need copying.
Old makefiles included code to manually copy all pngs, and this patch does
the same for meson.
I apologize for needing an external script just to run "cp -rf", it looks
like meson does not allow wildcards passed to "cp".
Files not in the output folder won't be included in the tarball and won't
be distributed.

Test Plan:
Generated documentation now includes images for pages like:
`group__Eina__List__Group.html#details`

Reviewers: bu5hm4n, lauromoura

Reviewed By: bu5hm4n

Subscribers: cedric, #reviewers, #committers, myoungwoon

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D10690

doc/efl_copy.sh [new file with mode: 0755]
doc/meson.build

diff --git a/doc/efl_copy.sh b/doc/efl_copy.sh
new file mode 100755 (executable)
index 0000000..af975fb
--- /dev/null
@@ -0,0 +1 @@
+cp $@
index 81c0e34..18b9aee 100644 (file)
@@ -104,6 +104,7 @@ widget_preview_eps = custom_target('widget_preview_prefs_epc',
 
 shot_sh = find_program('shot.sh')
 tar = find_program('tar')
+efl_copy = find_program('efl_copy.sh')
 
 foreach text_filter_property : text_filter_properties
   text = text_filter_property[0]
@@ -181,10 +182,17 @@ doc_target += custom_target('doxygen',
   build_by_default: false
 )
 
+# This is not pretty but meson does not seem to allow wildcards in plain cp commands
+copy_images = custom_target('documentation images',
+  command: [efl_copy, '-rf', join_paths(meson.current_source_dir(), 'img', '*.png'), 'html'],
+  output: ['empty_img_copy'],
+  build_by_default: false
+)
+
 compress_target = custom_target('package_doc_tar',
   command: [tar, '-C', meson.build_root(), '--xz',  '-cf', 'efl-'+meson.project_version()+'-doc.tar.xz', 'html', 'man'],
   output: 'efl-'+meson.project_version()+'-doc.tar.xz',
-  depends: doc_target,
+  depends: [doc_target, copy_images],
   build_by_default: false
 )