xref: /qemu/docs/meson.build (revision f8aa24ea9a82da38370470c6bc0eaa393999edfe)
1*f8aa24eaSPaolo BonziniSPHINX_ARGS = [config_host['SPHINX_BUILD'],
2*f8aa24eaSPaolo Bonzini               '-Dversion=' + meson.project_version(),
3*f8aa24eaSPaolo Bonzini               '-Drelease=' + config_host['PKGVERSION']]
4*f8aa24eaSPaolo Bonzini
5*f8aa24eaSPaolo Bonziniif get_option('werror')
6*f8aa24eaSPaolo Bonzini  SPHINX_ARGS += [ '-W' ]
7*f8aa24eaSPaolo Bonziniendif
8*f8aa24eaSPaolo Bonzini
9*f8aa24eaSPaolo Bonziniif build_docs
10*f8aa24eaSPaolo Bonzini  configure_file(output: 'index.html',
11*f8aa24eaSPaolo Bonzini                 input: files('index.html.in'),
12*f8aa24eaSPaolo Bonzini                 configuration: {'VERSION': meson.project_version()},
13*f8aa24eaSPaolo Bonzini                 install_dir: config_host['qemu_docdir'])
14*f8aa24eaSPaolo Bonzini  manuals = [ 'devel', 'interop', 'tools', 'specs', 'system', 'user' ]
15*f8aa24eaSPaolo Bonzini  man_pages = {
16*f8aa24eaSPaolo Bonzini    'interop' : {
17*f8aa24eaSPaolo Bonzini        'qemu-ga.8': (have_tools ? 'man8' : ''),
18*f8aa24eaSPaolo Bonzini    },
19*f8aa24eaSPaolo Bonzini    'tools': {
20*f8aa24eaSPaolo Bonzini        'qemu-img.1': (have_tools ? 'man1' : ''),
21*f8aa24eaSPaolo Bonzini        'qemu-nbd.8': (have_tools ? 'man8' : ''),
22*f8aa24eaSPaolo Bonzini        'qemu-trace-stap.1': (config_host.has_key('CONFIG_TRACE_SYSTEMTAP') ? 'man1' : ''),
23*f8aa24eaSPaolo Bonzini        'virtfs-proxy-helper.1': (have_virtfs_proxy_helper ? 'man1' : ''),
24*f8aa24eaSPaolo Bonzini        'virtiofsd.1': (have_virtiofsd ? 'man1' : ''),
25*f8aa24eaSPaolo Bonzini    },
26*f8aa24eaSPaolo Bonzini    'system': {
27*f8aa24eaSPaolo Bonzini        'qemu.1': 'man1',
28*f8aa24eaSPaolo Bonzini        'qemu-block-drivers.7': 'man7',
29*f8aa24eaSPaolo Bonzini        'qemu-cpu-models.7': 'man7'
30*f8aa24eaSPaolo Bonzini    },
31*f8aa24eaSPaolo Bonzini  }
32*f8aa24eaSPaolo Bonzini
33*f8aa24eaSPaolo Bonzini  sphinxdocs = []
34*f8aa24eaSPaolo Bonzini  sphinxmans = []
35*f8aa24eaSPaolo Bonzini  foreach manual : manuals
36*f8aa24eaSPaolo Bonzini    private_dir = meson.current_build_dir() / (manual + '.p')
37*f8aa24eaSPaolo Bonzini    input_dir = meson.current_source_dir() / manual
38*f8aa24eaSPaolo Bonzini    sphinxdocs += custom_target(manual + ' manual',
39*f8aa24eaSPaolo Bonzini                build_always_stale: true,
40*f8aa24eaSPaolo Bonzini                build_by_default: build_docs,
41*f8aa24eaSPaolo Bonzini                output: manual,
42*f8aa24eaSPaolo Bonzini                command: [SPHINX_ARGS, '-b', 'html', '-d', private_dir,
43*f8aa24eaSPaolo Bonzini                          input_dir, meson.current_build_dir() / manual])
44*f8aa24eaSPaolo Bonzini    if build_docs and manual != 'devel'
45*f8aa24eaSPaolo Bonzini      install_subdir(meson.current_build_dir() / manual,
46*f8aa24eaSPaolo Bonzini                     install_dir: config_host['qemu_docdir'])
47*f8aa24eaSPaolo Bonzini    endif
48*f8aa24eaSPaolo Bonzini
49*f8aa24eaSPaolo Bonzini    these_man_pages = []
50*f8aa24eaSPaolo Bonzini    install_dirs = []
51*f8aa24eaSPaolo Bonzini    foreach page, section : man_pages.get(manual, {})
52*f8aa24eaSPaolo Bonzini      these_man_pages += page
53*f8aa24eaSPaolo Bonzini      install_dirs += section == '' ? false : get_option('mandir') / section
54*f8aa24eaSPaolo Bonzini    endforeach
55*f8aa24eaSPaolo Bonzini    if these_man_pages.length() > 0
56*f8aa24eaSPaolo Bonzini      sphinxmans += custom_target(manual + ' man pages',
57*f8aa24eaSPaolo Bonzini                         build_always_stale: true,
58*f8aa24eaSPaolo Bonzini                         build_by_default: build_docs,
59*f8aa24eaSPaolo Bonzini                         output: these_man_pages,
60*f8aa24eaSPaolo Bonzini                         install: build_docs,
61*f8aa24eaSPaolo Bonzini                         install_dir: install_dirs,
62*f8aa24eaSPaolo Bonzini                         command: [SPHINX_ARGS, '-b', 'man', '-d', private_dir,
63*f8aa24eaSPaolo Bonzini                                   input_dir, meson.current_build_dir()])
64*f8aa24eaSPaolo Bonzini    endif
65*f8aa24eaSPaolo Bonzini  endforeach
66*f8aa24eaSPaolo Bonzini  alias_target('sphinxdocs', sphinxdocs)
67*f8aa24eaSPaolo Bonzini  alias_target('man', sphinxmans)
68*f8aa24eaSPaolo Bonziniendif
69