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