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