Commit 63a49edf authored by Thibault Saunier's avatar Thibault Saunier 🌵

docs: Generate ges plugin doc

parent aca18a29
......@@ -89,17 +89,31 @@ libs_doc = [hotdoc.generate_doc('gst-editing-services',
disable_incremental_build: true,
)]
plugins_doc = [hotdoc.generate_doc('nle',
project_version: apiversion,
extra_assets: [join_paths(meson.current_source_dir(), 'images')],
sitemap: 'nle-sitemap.txt',
index: 'nle-index.md',
dependencies: [nle],
disable_incremental_build: true,
gst_order_generated_subpages: true,
gst_index: 'nle-index.md',
gst_c_sources: ['../../plugins/nle/*.[ch]'],
gst_smart_index: true,
gst_cache_file: plugins_cache,
gst_plugin_name: 'nle',
)]
plugins_doc = []
list_plugin_res = run_command(python3, '-c',
'''
import sys
import json
with open("@0@") as f:
print(':'.join(json.load(f).keys()), end='')
'''.format(plugins_cache))
assert(list_plugin_res.returncode() == 0,
'Could not list plugins from @0@\n@1@\n@1@'.format(plugins_cache, list_plugin_res.stdout(), list_plugin_res.stderr()))
foreach plugin_name: list_plugin_res.stdout().split(':')
plugins_doc += [hotdoc.generate_doc(plugin_name,
project_version: apiversion,
sitemap: 'plugins/sitemap.txt',
index: 'plugins/index.md',
gst_index: 'plugins/index.md',
gst_smart_index: true,
gst_c_sources: ['../plugins/*/*.[ch]',],
dependencies: [gst_dep, plugins],
gst_order_generated_subpages: true,
gst_cache_file: plugins_cache,
gst_plugin_name: plugin_name,
)]
endforeach
......@@ -173,6 +173,7 @@ foreach extra_arg : warning_flags
endif
endforeach
python3 = import('python').find_installation()
configinc = include_directories('.')
subdir('ges')
subdir('plugins')
......@@ -209,7 +210,6 @@ else:
prefix, 'Lib', 'Python%d%d' % (version.major, version.minor),
'site-packages', 'gi', 'overrides'))
'''
python3 = import('python').find_installation()
pygi_override_dir = get_option('pygi-overrides-dir')
if pygi_override_dir == ''
cres = run_command(python3, '-c', override_detector, get_option('prefix'))
......
......@@ -20,7 +20,7 @@
*
**
* SECTION:gessrc
* SECTION:element-gessrc
* @short_description: A GstBin subclasses use to use GESTimeline
* as sources inside any GstPipeline.
* @see_also: #GESTimeline
......
......@@ -29,7 +29,7 @@
* SECTION:element-nleoperation
*
* A NleOperation performs a transformation or mixing operation on the
* data from one or more #NleSources, which is used to implement filters or
* data from one or more #NleSources, which is used to implement filters or
* effects.
*/
......@@ -131,7 +131,7 @@ nle_operation_class_init (NleOperationClass * klass)
*
* Specifies the number of sink pads the operation should provide.
* If the sinks property is -1 (the default) pads are only created as
* demanded via get_request_pad() calls on the element.
* demanded via `get_request_pad()` calls on the element.
*/
g_object_class_install_property (gobject_class, ARG_SINKS,
g_param_spec_int ("sinks", "Sinks",
......@@ -306,7 +306,7 @@ get_src_pad (GstElement * element)
}
/* get_nb_static_sinks:
*
*
* Returns : The number of static sink pads of the controlled element.
*/
static guint
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment