3 if meson.is_cross_build()
4 if get_option('doc').enabled()
5 error('Documentation enabled but building the doc while cross building is not supported yet.')
8 message('Documentation not built as building it while cross building is not supported yet.')
13 if get_option('doc').enabled()
14 error('Documentation enabled but not supported when building statically.')
17 message('Building statically, can\'t build the documentation')
21 required_hotdoc_extensions = ['gst-extension']
22 plugins_cache = join_paths(meson.current_source_dir(), 'gst_plugins_cache.json')
23 if gst_dep.type_name() == 'internal'
24 gst_proj = subproject('gstreamer')
25 plugins_cache_generator = gst_proj.get_variable('plugins_cache_generator')
27 plugins_cache_generator = find_program(join_paths(gst_dep.get_variable('libexecdir'), 'gstreamer-' + api_version, 'gst-plugins-doc-cache-generator'),
31 if plugins.length() == 0
32 message('All ugly plugins have been disabled')
33 elif plugins_cache_generator.found()
34 gst_plugins_doc_dep = custom_target('ugly-plugins-doc-cache',
35 command: [plugins_cache_generator, plugins_cache, '@OUTPUT@', '@INPUT@'],
37 output: 'gst_plugins_cache.json',
38 build_always_stale: true,
41 warning('GStreamer plugin inspector for documentation not found, can\'t update the cache')
44 hotdoc_p = find_program('hotdoc', required: get_option('doc'))
45 if not hotdoc_p.found()
46 message('Hotdoc not found, not building the documentation')
50 hotdoc_req = '>= 0.11.0'
51 hotdoc_version = run_command(hotdoc_p, '--version', check: false).stdout()
52 if not hotdoc_version.version_compare(hotdoc_req)
53 if get_option('doc').enabled()
54 error('Hotdoc version @0@ not found, got @1@'.format(hotdoc_req, hotdoc_version))
56 message('Hotdoc version @0@ not found, got @1@'.format(hotdoc_req, hotdoc_version))
61 hotdoc = import('hotdoc')
62 foreach extension: required_hotdoc_extensions
63 if not hotdoc.has_extensions(extension)
64 if get_option('doc').enabled()
65 error('Documentation enabled but @0@ missing'.format(extension))
68 message('@0@ extension not found, not building documentation'.format(extension))
74 docconf = configuration_data()
75 docconf.set('GST_API_VERSION', api_version)
77 configure_file(input : 'gst_api_version.in',
78 output : 'gst_api_version.md',
79 configuration : docconf)
84 excludes += [join_paths(meson.current_source_dir(), root_rel, '..', f)]
89 list_plugin_res = run_command(python3, '-c',
94 with open("@0@") as f:
95 print(':'.join(json.load(f).keys()), end='')
96 '''.format(plugins_cache),
98 foreach plugin_name: list_plugin_res.stdout().split(':')
99 plugins_doc += [hotdoc.generate_doc(plugin_name,
100 project_version: api_version,
101 sitemap: 'sitemap.txt',
103 gst_index: 'index.md',
104 gst_smart_index: true,
106 join_paths(root_rel, 'sys/*/*.[ch]'),
107 join_paths(root_rel, 'ext/*/*.[ch]'),
108 join_paths(root_rel, 'gst/*/*.[ch]'),
110 gst_c_source_filters: excludes,
111 dependencies: [gst_dep],
112 gst_order_generated_subpages: true,
113 disable_incremental_build: true,
114 gst_cache_file: plugins_cache,
115 gst_plugin_name: plugin_name,