mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/doc/meson.build

218 lines
7.3 KiB
Meson
Raw Normal View History

Add doxygen docs
2017-05-30 19:46:51 +02:00
doxyfile_conf = configuration_data()
doxyfile_conf.set('PACKAGE_NAME', meson.project_name())
doxyfile_conf.set('PACKAGE_VERSION', meson.project_version())
treewide: meson.build: use project_{build,source}_root() Use `meson.project_{build,source}_root()` instead of `meson.{build,source}_root()` because those functions do not work as expected when used inside a subproject, and they have been deprecated in meson 0.56.0.
2021-12-28 16:35:20 +01:00
doxyfile_conf.set('top_srcdir', meson.project_source_root())
doxyfile_conf.set('top_builddir', meson.project_build_root())
doc: specify Doxygen OUTPUT_DIRECTORY as an absolute path Currently, doxygen is run by ninja in the top-level build directory, therefore the "doc" folder is always created there. However, when pipewire is built as a subproject, it should not touch the top-level build directory because it can cause conflicts and because the documentation won't be created where meson thinks it will be, so the "doxygen" target will always be dirty and installation will fail.
2023-01-14 22:02:13 +01:00
doxyfile_conf.set('output_directory', meson.current_build_dir())
Add doxygen docs
2017-05-30 19:46:51 +02:00
meson.build: adds summary() to optional programs
2021-06-29 11:17:03 +03:00
dot_found = find_program('dot', required: false).found()
summary({'dot (used with doxygen)': dot_found}, bool_yn: true, section: 'Optional programs')
if dot_found
Add doxygen docs
2017-05-30 19:46:51 +02:00
doxyfile_conf.set('HAVE_DOT', 'YES')
else
doxyfile_conf.set('HAVE_DOT', 'NO')
endif
doc: switch from .md to .dox files and impose some general structure This is an attempt of breaking up the documentation, currently spread across several pages. We're left with a few high-level topics with various things grouped underneath those. Further refinement is necessary, but this can now be done in incremental steps over massive reworks.
2021-05-25 19:55:06 +10:00
# Note: order here is how doxygen will expose the pages in the sidebar
doc: reorganize files Separate various autogen files from the documentation .dox files. Rename .dox files to match the intended tree structure.
2023-11-18 15:13:05 +02:00
# tree.dox should be first to determine the ordering.
doc: add the various markdown prose docs to the doxygen output Note that the order of the includes matters - that's how doxygen will sort them. There is no specific structure other than the include order - one reason why the headers are being changed. Without polluting the markdown files with doxygen commands we cannot use \subpage, so all files convert to a regular \page and are listed as flat hierarchy in the sidebar (and in Related Pages). Changing the headers at least provides some visual grouping with comon prefixes.
2021-05-07 09:09:45 +10:00
extra_docs = [
doc: reorganize files Separate various autogen files from the documentation .dox files. Rename .dox files to match the intended tree structure.
2023-11-18 15:13:05 +02:00
'tree.dox',
'dox/index.dox',
'dox/overview.dox',
'dox/modules.dox',
doc: add documentation for pipewire-pulse modules Add (minimal) reference documentation for each pipewire-pulse module. Add some preprocessing to substitute @pulse_module_options@ in docs from PW_KEY_MODULE_USAGE so the module options don't need to be repeated. Produce Doxygen docs + generate manpages pipewire-pulse-modules.7, pipewire-pulse-module-*.7
2023-11-19 23:08:09 +02:00
'dox/pulse-modules.dox',
doc: reorganize files Separate various autogen files from the documentation .dox files. Rename .dox files to match the intended tree structure.
2023-11-18 15:13:05 +02:00
'dox/internals/index.dox',
'dox/internals/design.dox',
'dox/internals/access.dox',
'dox/internals/midi.dox',
'dox/internals/portal.dox',
'dox/internals/daemon.dox',
'dox/internals/library.dox',
'dox/internals/session-manager.dox',
'dox/internals/objects.dox',
'dox/internals/audio.dox',
'dox/internals/scheduling.dox',
'dox/internals/protocol.dox',
'dox/internals/pulseaudio.dox',
'dox/internals/dma-buf.dox',
'dox/tutorial/index.dox',
'dox/tutorial/tutorial1.dox',
'dox/tutorial/tutorial2.dox',
'dox/tutorial/tutorial3.dox',
'dox/tutorial/tutorial4.dox',
'dox/tutorial/tutorial5.dox',
'dox/tutorial/tutorial6.dox',
'dox/api/index.dox',
'dox/api/spa-index.dox',
'dox/api/spa-plugins.dox',
'dox/api/spa-design.dox',
'dox/api/spa-pod.dox',
'dox/api/spa-buffer.dox',
doc: add the various markdown prose docs to the doxygen output Note that the order of the includes matters - that's how doxygen will sort them. There is no specific structure other than the include order - one reason why the headers are being changed. Without polluting the markdown files with doxygen commands we cannot use \subpage, so all files convert to a regular \page and are listed as flat hierarchy in the sidebar (and in Related Pages). Changing the headers at least provides some visual grouping with comon prefixes.
2021-05-07 09:09:45 +10:00
]
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
inputs = []
doc: add the various markdown prose docs to the doxygen output Note that the order of the includes matters - that's how doxygen will sort them. There is no specific structure other than the include order - one reason why the headers are being changed. Without polluting the markdown files with doxygen commands we cannot use \subpage, so all files convert to a regular \page and are listed as flat hierarchy in the sidebar (and in Related Pages). Changing the headers at least provides some visual grouping with comon prefixes.
2021-05-07 09:09:45 +10:00
foreach extra : extra_docs
treewide: meson.build: use project_{build,source}_root() Use `meson.project_{build,source}_root()` instead of `meson.{build,source}_root()` because those functions do not work as expected when used inside a subproject, and they have been deprecated in meson 0.56.0.
2021-12-28 16:35:20 +01:00
inputs += meson.project_source_root() / 'doc' / extra
doc: add the various markdown prose docs to the doxygen output Note that the order of the includes matters - that's how doxygen will sort them. There is no specific structure other than the include order - one reason why the headers are being changed. Without polluting the markdown files with doxygen commands we cannot use \subpage, so all files convert to a regular \page and are listed as flat hierarchy in the sidebar (and in Related Pages). Changing the headers at least provides some visual grouping with comon prefixes.
2021-05-07 09:09:45 +10:00
endforeach
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
foreach h : pipewire_headers
treewide: meson.build: use project_{build,source}_root() Use `meson.project_{build,source}_root()` instead of `meson.{build,source}_root()` because those functions do not work as expected when used inside a subproject, and they have been deprecated in meson 0.56.0.
2021-12-28 16:35:20 +01:00
inputs += meson.project_source_root() / 'src' / 'pipewire' / h
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
endforeach
foreach h : pipewire_ext_headers
treewide: meson.build: use project_{build,source}_root() Use `meson.project_{build,source}_root()` instead of `meson.{build,source}_root()` because those functions do not work as expected when used inside a subproject, and they have been deprecated in meson 0.56.0.
2021-12-28 16:35:20 +01:00
inputs += meson.project_source_root() / 'src' / 'pipewire' / 'extensions' / h
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
endforeach
foreach h : pipewire_ext_sm_headers
treewide: meson.build: use project_{build,source}_root() Use `meson.project_{build,source}_root()` instead of `meson.{build,source}_root()` because those functions do not work as expected when used inside a subproject, and they have been deprecated in meson 0.56.0.
2021-12-28 16:35:20 +01:00
inputs += meson.project_source_root() / 'src' / 'pipewire' / 'extensions' / h
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
endforeach
foreach h : pipewire_sources
treewide: meson.build: use project_{build,source}_root() Use `meson.project_{build,source}_root()` instead of `meson.{build,source}_root()` because those functions do not work as expected when used inside a subproject, and they have been deprecated in meson 0.56.0.
2021-12-28 16:35:20 +01:00
inputs += meson.project_source_root() / 'src' / 'pipewire' / h
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
endforeach
foreach h : module_sources
treewide: meson.build: use project_{build,source}_root() Use `meson.project_{build,source}_root()` instead of `meson.{build,source}_root()` because those functions do not work as expected when used inside a subproject, and they have been deprecated in meson 0.56.0.
2021-12-28 16:35:20 +01:00
inputs += meson.project_source_root() / 'src' / 'modules' / h
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
endforeach
doc: add documentation for pipewire-pulse modules Add (minimal) reference documentation for each pipewire-pulse module. Add some preprocessing to substitute @pulse_module_options@ in docs from PW_KEY_MODULE_USAGE so the module options don't need to be repeated. Produce Doxygen docs + generate manpages pipewire-pulse-modules.7, pipewire-pulse-module-*.7
2023-11-19 23:08:09 +02:00
foreach h : pipewire_module_protocol_pulse_sources
inputs += meson.project_source_root() / 'src' / 'modules' / h
endforeach
treewide: meson.build: use project_{build,source}_root() Use `meson.project_{build,source}_root()` instead of `meson.{build,source}_root()` because those functions do not work as expected when used inside a subproject, and they have been deprecated in meson 0.56.0.
2021-12-28 16:35:20 +01:00
input_dirs = [ meson.project_source_root() / 'spa' / 'include' / 'spa' ]
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
path_prefixes = [
treewide: meson.build: use project_{build,source}_root() Use `meson.project_{build,source}_root()` instead of `meson.{build,source}_root()` because those functions do not work as expected when used inside a subproject, and they have been deprecated in meson 0.56.0.
2021-12-28 16:35:20 +01:00
meson.project_source_root() / 'src',
meson.project_source_root() / 'spa' / 'include',
meson.project_source_root(),
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
]
doc: add the various markdown prose docs to the doxygen output Note that the order of the includes matters - that's how doxygen will sort them. There is no specific structure other than the include order - one reason why the headers are being changed. Without polluting the markdown files with doxygen commands we cannot use \subpage, so all files convert to a regular \page and are listed as flat hierarchy in the sidebar (and in Related Pages). Changing the headers at least provides some visual grouping with comon prefixes.
2021-05-07 09:09:45 +10:00
doc: add a custom doxygen theme based on doxygen-awesome Theme from doxygen-awesome-css with custom modifications based on the pipewire.org website to use the same type of blue, grey, etc. doxygen-awesome-css is MIT licensed, see https://github.com/jothepro/doxygen-awesome-css
2021-05-21 14:53:48 +10:00
cssfiles = [
treewide: meson.build: use project_{build,source}_root() Use `meson.project_{build,source}_root()` instead of `meson.{build,source}_root()` because those functions do not work as expected when used inside a subproject, and they have been deprecated in meson 0.56.0.
2021-12-28 16:35:20 +01:00
meson.project_source_root() / 'doc' / 'doxygen-awesome.css',
meson.project_source_root() / 'doc' / 'custom.css'
doc: add a custom doxygen theme based on doxygen-awesome Theme from doxygen-awesome-css with custom modifications based on the pipewire.org website to use the same type of blue, grey, etc. doxygen-awesome-css is MIT licensed, see https://github.com/jothepro/doxygen-awesome-css
2021-05-21 14:53:48 +10:00
]
doc: link examples to Doxygen docs Include examples to the documentation, using Doxygen's example system.
2021-10-09 23:25:29 +03:00
# Example files (in order from simple to esoteric)
example_files = [
doc: add tutorials as Doxygen examples
2021-10-10 00:09:32 +03:00
'tutorial1.c',
'tutorial2.c',
'tutorial3.c',
'tutorial4.c',
'tutorial5.c',
'tutorial6.c',
doc: link examples to Doxygen docs Include examples to the documentation, using Doxygen's example system.
2021-10-09 23:25:29 +03:00
]
meson: ensure all examples are included in doc Move declaration of examples to use same file lists for build and docs.
2021-10-31 14:17:58 +02:00
foreach h : examples
example_files += [h + '.c']
endforeach
foreach h : spa_examples
example_files += ['spa/examples/' + h + '.c']
endforeach
doc: link examples to Doxygen docs Include examples to the documentation, using Doxygen's example system.
2021-10-09 23:25:29 +03:00
example_doxygen = []
example_ref = []
foreach h : example_files
example_doxygen += ['\\example ' + h,
'\\snippet{doc} ' + h + ' title',
'<br>',
'\\snippet{doc} ' + h + ' doc']
example_ref += ['- \\ref ' + h + ' "": \snippet{doc} ' + h + ' title']
endforeach
examples_dox_conf = configuration_data()
examples_dox_conf.set('example_doxygen', '\n'.join(example_doxygen))
examples_dox_conf.set('example_ref', '\n'.join(example_ref))
examples_dox = configure_file(input: 'examples.dox.in',
output: 'examples.dox',
configuration: examples_dox_conf)
input_dirs += [ 'doc/examples.dox' ]
doc: include manpages in html docs Include manpages as raw text in html docs. Simple and readable enough...
2022-01-20 21:06:54 +02:00
man_doxygen = []
man_subpages = []
foreach m : manpages
manconf = configuration_data()
pagename = 'page_man_' + m.split('.rst.in').get(0).replace('.', '_').replace('-', '_')
filename = m.split('.rst.in').get(0) + '.dox'
manconf.set('pagename', pagename)
manconf.set('title', m.split('.rst.in').get(0).replace('.1','').replace('.5',''))
manconf.set('filename', meson.project_source_root() / 'man' / m)
manfile = configure_file(input: 'manpage.dox.in',
output: filename,
configuration: manconf)
man_doxygen += [manfile]
man_subpages += ['- \subpage ' + pagename]
input_dirs += [ 'doc/' + filename ]
endforeach
doc: reorganize files Separate various autogen files from the documentation .dox files. Rename .dox files to match the intended tree structure.
2023-11-18 15:13:05 +02:00
pw_programs_dox_conf = configuration_data()
pw_programs_dox_conf.set('man_subpages', '\n'.join(man_subpages))
pw_programs_dox = configure_file(input: 'programs.dox.in',
output: 'programs.dox',
configuration: pw_programs_dox_conf)
input_dirs += [ 'doc/programs.dox' ]
doc: include manpages in html docs Include manpages as raw text in html docs. Simple and readable enough...
2022-01-20 21:06:54 +02:00
doc: fixup some Doxygen autogen issues Don't show page sections in left sidebar, it's confusing. Rename Modules -> API Reference in sidebar. Indicate visually the sidebar entries are collapsible. Fix spa_pod_json grouping. Move tools page to top level. Fix page ordering.
2023-11-04 11:26:27 +02:00
doxygen_layout = meson.project_source_root() / 'doc' / 'DoxygenLayout.xml'
doc: add documentation for pipewire-pulse modules Add (minimal) reference documentation for each pipewire-pulse module. Add some preprocessing to substitute @pulse_module_options@ in docs from PW_KEY_MODULE_USAGE so the module options don't need to be repeated. Produce Doxygen docs + generate manpages pipewire-pulse-modules.7, pipewire-pulse-module-*.7
2023-11-19 23:08:09 +02:00
doxygen_filter_c = meson.project_source_root() / 'doc' / 'input-filter.py'
doc: hide useless indices in doxygen output etc. fixes Hide useless paginated indices. Rename "Related Pages" -> "Pages". Fix manpage brief description. Fix file path name stripping. Move macro listings after enums, so that they're next to functions. Remove pwtest from docs, it's not API. Fixup header styles.
2023-11-04 12:35:30 +02:00
doxygen_filter_h = meson.project_source_root() / 'doc' / 'input-filter-h.sh'
doc: fixup some Doxygen autogen issues Don't show page sections in left sidebar, it's confusing. Rename Modules -> API Reference in sidebar. Indicate visually the sidebar entries are collapsible. Fix spa_pod_json grouping. Move tools page to top level. Fix page ordering.
2023-11-04 11:26:27 +02:00
doc: fix meson dependency list Meson doesn't accept directories in input dependency list.
2021-10-04 22:14:38 +03:00
doxyfile_conf.set('inputs', ' '.join(inputs + input_dirs))
doc: add a custom doxygen theme based on doxygen-awesome Theme from doxygen-awesome-css with custom modifications based on the pipewire.org website to use the same type of blue, grey, etc. doxygen-awesome-css is MIT licensed, see https://github.com/jothepro/doxygen-awesome-css
2021-05-21 14:53:48 +10:00
doxyfile_conf.set('cssfiles', ' '.join(cssfiles))
doc: fixup some Doxygen autogen issues Don't show page sections in left sidebar, it's confusing. Rename Modules -> API Reference in sidebar. Indicate visually the sidebar entries are collapsible. Fix spa_pod_json grouping. Move tools page to top level. Fix page ordering.
2023-11-04 11:26:27 +02:00
doxyfile_conf.set('layout', doxygen_layout)
doc: make Doxygen to show only symbols defined in headers Make Doxygen data structure etc. lists less cluttered by hiding non-public stuff. Add a Doxygen input filter that marks symbols declared in C files private, so that they won't appear in the output unless the symbol is also declared in a header. The "spa static inline" hack is then also not needed any more.
2021-10-02 19:24:17 +03:00
doxyfile_conf.set('path_prefixes', ' '.join(path_prefixes))
doc: hide useless indices in doxygen output etc. fixes Hide useless paginated indices. Rename "Related Pages" -> "Pages". Fix manpage brief description. Fix file path name stripping. Move macro listings after enums, so that they're next to functions. Remove pwtest from docs, it's not API. Fixup header styles.
2023-11-04 12:35:30 +02:00
doxyfile_conf.set('c_input_filter', doxygen_filter_c)
doxyfile_conf.set('h_input_filter', doxygen_filter_h)
update docs
2017-09-05 13:35:25 +02:00
Add doxygen docs
2017-05-30 19:46:51 +02:00
doxyfile = configure_file(input: 'Doxyfile.in',
output: 'Doxyfile',
require meson 0.49
2020-05-19 16:49:38 +02:00
configuration: doxyfile_conf)
Add doxygen docs
2017-05-30 19:46:51 +02:00
doc: add docdir option As patched in Gentoo. Fixes #1057
2021-04-15 21:45:53 +03:00
docdir = get_option('docdir')
if docdir == ''
docdir = pipewire_datadir / 'doc' / meson.project_name()
endif
Add doxygen docs
2017-05-30 19:46:51 +02:00
html_target = custom_target('pipewire-docs',
doc: reorganize files Separate various autogen files from the documentation .dox files. Rename .dox files to match the intended tree structure.
2023-11-18 15:13:05 +02:00
input: [ doxyfile, doxygen_layout, examples_dox, pw_programs_dox, doxygen_filter_c, doxygen_filter_h ] + inputs + cssfiles + man_doxygen,
Add doxygen docs
2017-05-30 19:46:51 +02:00
output: [ 'html' ],
command: [ doxygen, doxyfile ],
install: true,
doc: add docdir option As patched in Gentoo. Fixes #1057
2021-04-15 21:45:53 +03:00
install_dir: docdir)
doc: generate man-pages also for pipewire modules Use pandoc + some processing to convert Doxygen html output to man pages. Requires pandoc & python for building. Generates manpages: libpipewire-modules.7, libpipewire-module-*.7
2023-11-18 20:04:06 +02:00
meson.build: make pandoc optional Skip only pandoc-requiring parts if it is not available.
2023-11-21 18:04:48 +02:00
if generate_extra_manpages
doc: generate man-pages also for pipewire modules Use pandoc + some processing to convert Doxygen html output to man pages. Requires pandoc & python for building. Generates manpages: libpipewire-modules.7, libpipewire-module-*.7
2023-11-18 20:04:06 +02:00
module_man_rst_py = meson.project_source_root() / 'doc' / 'module-man-rst.py'
module_man_defines = []
foreach m : manpage_conf.keys()
if m != 'LIBPIPEWIRE_MODULES'
module_man_defines += ['-D', m, manpage_conf.get(m)]
endif
endforeach
doc: add documentation for pipewire-pulse modules Add (minimal) reference documentation for each pipewire-pulse module. Add some preprocessing to substitute @pulse_module_options@ in docs from PW_KEY_MODULE_USAGE so the module options don't need to be repeated. Produce Doxygen docs + generate manpages pipewire-pulse-modules.7, pipewire-pulse-module-*.7
2023-11-19 23:08:09 +02:00
module_manpage_names = []
doc: generate man-pages also for pipewire modules Use pandoc + some processing to convert Doxygen html output to man pages. Requires pandoc & python for building. Generates manpages: libpipewire-modules.7, libpipewire-module-*.7
2023-11-18 20:04:06 +02:00
foreach m : module_sources
doc: add documentation for pipewire-pulse modules Add (minimal) reference documentation for each pipewire-pulse module. Add some preprocessing to substitute @pulse_module_options@ in docs from PW_KEY_MODULE_USAGE so the module options don't need to be repeated. Produce Doxygen docs + generate manpages pipewire-pulse-modules.7, pipewire-pulse-module-*.7
2023-11-19 23:08:09 +02:00
name = m.split('.c').get(0)
file = f'libpipewire-@name@.7'
module_manpage_names += [[name, file]]
endforeach
foreach m : pipewire_module_protocol_pulse_sources
name = m.split('/').get(-1).split('.c').get(0)
if m.contains('/modules/') and name.startswith('module-')
name = f'pulse-@name@'
file = f'pipewire-@name@.7'
module_manpage_names += [[name, file]]
endif
endforeach
foreach item : module_manpage_names
name = item.get(0)
file = item.get(1)
doc: generate man-pages also for pipewire modules Use pandoc + some processing to convert Doxygen html output to man pages. Requires pandoc & python for building. Generates manpages: libpipewire-modules.7, libpipewire-module-*.7
2023-11-18 20:04:06 +02:00
rst = custom_target(file + '.rst',
command : [python, module_man_rst_py, pandoc, name, '@INPUT@' ] + module_man_defines,
input : [ html_target ],
depend_files : [ module_man_rst_py ],
output : file + '.rst',
capture : true
)
custom_target(file,
output : file,
input : rst,
command : [rst2man, '@INPUT@', '@OUTPUT@'],
install : true,
install_dir : get_option('mandir') / 'man7')
endforeach
endif
Reference in a new issue Copy permalink