mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-10-29 05:40:27 -04:00
doc: include manpages in html docs
Include manpages as raw text in html docs. Simple and readable enough...
This commit is contained in:
parent
695f8dfdd9
commit
88e744a06f
16 changed files with 56 additions and 36 deletions
5
doc/manpage.dox.in
Normal file
5
doc/manpage.dox.in
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
/** \page @pagename@ @title@
|
||||
|
||||
\verbinclude @filename@
|
||||
|
||||
*/
|
||||
|
|
@ -26,7 +26,6 @@ extra_docs = [
|
|||
'pipewire-daemon.dox',
|
||||
'pipewire-library.dox',
|
||||
'pipewire-modules.dox',
|
||||
'pipewire-tools.dox',
|
||||
'pipewire-session-manager.dox',
|
||||
'pipewire-objects-design.dox',
|
||||
'pipewire-audio.dox',
|
||||
|
|
@ -115,6 +114,30 @@ examples_dox = configure_file(input: 'examples.dox.in',
|
|||
|
||||
input_dirs += [ 'doc/examples.dox' ]
|
||||
|
||||
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
|
||||
|
||||
pw_tools_dox_conf = configuration_data()
|
||||
pw_tools_dox_conf.set('man_subpages', '\n'.join(man_subpages))
|
||||
pw_tools_dox = configure_file(input: 'pipewire-tools.dox.in',
|
||||
output: 'pipewire-tools.dox',
|
||||
configuration: pw_tools_dox_conf)
|
||||
input_dirs += [ 'doc/pipewire-tools.dox' ]
|
||||
|
||||
doxyfile_conf.set('inputs', ' '.join(inputs + input_dirs))
|
||||
doxyfile_conf.set('cssfiles', ' '.join(cssfiles))
|
||||
doxyfile_conf.set('path_prefixes', ' '.join(path_prefixes))
|
||||
|
|
@ -131,7 +154,7 @@ if docdir == ''
|
|||
endif
|
||||
|
||||
html_target = custom_target('pipewire-docs',
|
||||
input: [ doxyfile, examples_dox ] + inputs + cssfiles,
|
||||
input: [ doxyfile, examples_dox, pw_tools_dox ] + inputs + cssfiles + man_doxygen,
|
||||
output: [ 'html' ],
|
||||
command: [ doxygen, doxyfile ],
|
||||
install: true,
|
||||
|
|
|
|||
|
|
@ -1,4 +1,7 @@
|
|||
/** \page page_tools PipeWire Tools
|
||||
|
||||
*/
|
||||
Manual pages:
|
||||
|
||||
@man_subpages@
|
||||
|
||||
*/
|
||||
Loading…
Add table
Add a link
Reference in a new issue