1e3667660SYonggang Luoif get_option('sphinx_build') == '' 2e3667660SYonggang Luo sphinx_build = find_program(['sphinx-build-3', 'sphinx-build'], 3e3667660SYonggang Luo required: get_option('docs')) 4e3667660SYonggang Luoelse 5e3667660SYonggang Luo sphinx_build = find_program(get_option('sphinx_build'), 6e3667660SYonggang Luo required: get_option('docs')) 7e3667660SYonggang Luoendif 8e3667660SYonggang Luo 9e3667660SYonggang Luo# Check if tools are available to build documentation. 10e3667660SYonggang Luobuild_docs = false 11e3667660SYonggang Luoif sphinx_build.found() 12e3667660SYonggang Luo SPHINX_ARGS = [sphinx_build] 13e3667660SYonggang Luo # If we're making warnings fatal, apply this to Sphinx runs as well 14e3667660SYonggang Luo if get_option('werror') 15e3667660SYonggang Luo SPHINX_ARGS += [ '-W' ] 16e3667660SYonggang Luo endif 17e3667660SYonggang Luo 18e3667660SYonggang Luo # This is a bit awkward but works: create a trivial document and 19e3667660SYonggang Luo # try to run it with our configuration file (which enforces a 20e3667660SYonggang Luo # version requirement). This will fail if sphinx-build is too old. 21e3667660SYonggang Luo run_command('mkdir', ['-p', tmpdir / 'sphinx']) 22e3667660SYonggang Luo run_command('touch', [tmpdir / 'sphinx/index.rst']) 23e3667660SYonggang Luo sphinx_build_test_out = run_command(SPHINX_ARGS + [ 24e3667660SYonggang Luo '-c', meson.current_source_dir(), 25e3667660SYonggang Luo '-b', 'html', tmpdir / 'sphinx', 26e3667660SYonggang Luo tmpdir / 'sphinx/out']) 27e3667660SYonggang Luo build_docs = (sphinx_build_test_out.returncode() == 0) 28e3667660SYonggang Luo 29e3667660SYonggang Luo if not build_docs 30*af2c0e85SPaolo Bonzini warning('@0@ is either too old or uses too old a Python version' 31*af2c0e85SPaolo Bonzini .format(sphinx_build.full_path())) 32e3667660SYonggang Luo if get_option('docs').enabled() 33e3667660SYonggang Luo error('Install a Python 3 version of python-sphinx') 34e3667660SYonggang Luo endif 35e3667660SYonggang Luo endif 36e3667660SYonggang Luoendif 37e3667660SYonggang Luo 38f8aa24eaSPaolo Bonziniif build_docs 39e3667660SYonggang Luo SPHINX_ARGS += ['-Dversion=' + meson.project_version(), '-Drelease=' + config_host['PKGVERSION']] 40e3667660SYonggang Luo 41e3667660SYonggang Luo sphinx_extn_depends = [ meson.source_root() / 'docs/sphinx/depfile.py', 42e3667660SYonggang Luo meson.source_root() / 'docs/sphinx/hxtool.py', 43e3667660SYonggang Luo meson.source_root() / 'docs/sphinx/kerneldoc.py', 44e3667660SYonggang Luo meson.source_root() / 'docs/sphinx/kernellog.py', 45e3667660SYonggang Luo meson.source_root() / 'docs/sphinx/qapidoc.py', 46e3667660SYonggang Luo meson.source_root() / 'docs/sphinx/qmp_lexer.py', 47e3667660SYonggang Luo qapi_gen_depends ] 48e3667660SYonggang Luo 49f8aa24eaSPaolo Bonzini configure_file(output: 'index.html', 50f8aa24eaSPaolo Bonzini input: files('index.html.in'), 51f8aa24eaSPaolo Bonzini configuration: {'VERSION': meson.project_version()}, 52491e74c1SMarc-André Lureau install_dir: qemu_docdir) 53f8aa24eaSPaolo Bonzini manuals = [ 'devel', 'interop', 'tools', 'specs', 'system', 'user' ] 54f8aa24eaSPaolo Bonzini man_pages = { 55f8aa24eaSPaolo Bonzini 'interop' : { 56f8aa24eaSPaolo Bonzini 'qemu-ga.8': (have_tools ? 'man8' : ''), 57db16115fSPeter Maydell 'qemu-ga-ref.7': 'man7', 584ac2ee19SPeter Maydell 'qemu-qmp-ref.7': 'man7', 59f8aa24eaSPaolo Bonzini }, 60f8aa24eaSPaolo Bonzini 'tools': { 61f8aa24eaSPaolo Bonzini 'qemu-img.1': (have_tools ? 'man1' : ''), 62f8aa24eaSPaolo Bonzini 'qemu-nbd.8': (have_tools ? 'man8' : ''), 63f8aa24eaSPaolo Bonzini 'qemu-trace-stap.1': (config_host.has_key('CONFIG_TRACE_SYSTEMTAP') ? 'man1' : ''), 64f8aa24eaSPaolo Bonzini 'virtfs-proxy-helper.1': (have_virtfs_proxy_helper ? 'man1' : ''), 65f8aa24eaSPaolo Bonzini 'virtiofsd.1': (have_virtiofsd ? 'man1' : ''), 66f8aa24eaSPaolo Bonzini }, 67f8aa24eaSPaolo Bonzini 'system': { 68f8aa24eaSPaolo Bonzini 'qemu.1': 'man1', 69f8aa24eaSPaolo Bonzini 'qemu-block-drivers.7': 'man7', 70f8aa24eaSPaolo Bonzini 'qemu-cpu-models.7': 'man7' 71f8aa24eaSPaolo Bonzini }, 72f8aa24eaSPaolo Bonzini } 73f8aa24eaSPaolo Bonzini 74f8aa24eaSPaolo Bonzini sphinxdocs = [] 75f8aa24eaSPaolo Bonzini sphinxmans = [] 76f8aa24eaSPaolo Bonzini foreach manual : manuals 77f8aa24eaSPaolo Bonzini private_dir = meson.current_build_dir() / (manual + '.p') 78bac35bf5SPaolo Bonzini output_dir = meson.current_build_dir() / manual 79f8aa24eaSPaolo Bonzini input_dir = meson.current_source_dir() / manual 80bac35bf5SPaolo Bonzini 81bac35bf5SPaolo Bonzini this_manual = custom_target(manual + ' manual', 82f8aa24eaSPaolo Bonzini build_by_default: build_docs, 83bac35bf5SPaolo Bonzini output: [manual + '.stamp'], 84bac35bf5SPaolo Bonzini input: [files('conf.py'), files(manual / 'conf.py')], 85bac35bf5SPaolo Bonzini depfile: manual + '.d', 86b3f4830aSPeter Maydell depend_files: sphinx_extn_depends, 87bac35bf5SPaolo Bonzini command: [SPHINX_ARGS, '-Ddepfile=@DEPFILE@', 88bac35bf5SPaolo Bonzini '-Ddepfile_stamp=@OUTPUT0@', 89bac35bf5SPaolo Bonzini '-b', 'html', '-d', private_dir, 90bac35bf5SPaolo Bonzini input_dir, output_dir]) 91bac35bf5SPaolo Bonzini sphinxdocs += this_manual 92f8aa24eaSPaolo Bonzini if build_docs and manual != 'devel' 93491e74c1SMarc-André Lureau install_subdir(output_dir, install_dir: qemu_docdir) 94f8aa24eaSPaolo Bonzini endif 95f8aa24eaSPaolo Bonzini 96f8aa24eaSPaolo Bonzini these_man_pages = [] 97f8aa24eaSPaolo Bonzini install_dirs = [] 98f8aa24eaSPaolo Bonzini foreach page, section : man_pages.get(manual, {}) 99f8aa24eaSPaolo Bonzini these_man_pages += page 100f8aa24eaSPaolo Bonzini install_dirs += section == '' ? false : get_option('mandir') / section 101f8aa24eaSPaolo Bonzini endforeach 102f8aa24eaSPaolo Bonzini if these_man_pages.length() > 0 103f8aa24eaSPaolo Bonzini sphinxmans += custom_target(manual + ' man pages', 104f8aa24eaSPaolo Bonzini build_by_default: build_docs, 105f8aa24eaSPaolo Bonzini output: these_man_pages, 106bac35bf5SPaolo Bonzini input: this_manual, 107f8aa24eaSPaolo Bonzini install: build_docs, 108f8aa24eaSPaolo Bonzini install_dir: install_dirs, 109f8aa24eaSPaolo Bonzini command: [SPHINX_ARGS, '-b', 'man', '-d', private_dir, 110f8aa24eaSPaolo Bonzini input_dir, meson.current_build_dir()]) 111f8aa24eaSPaolo Bonzini endif 112f8aa24eaSPaolo Bonzini endforeach 113f8aa24eaSPaolo Bonzini alias_target('sphinxdocs', sphinxdocs) 1144ac2ee19SPeter Maydell alias_target('html', sphinxdocs) 115f8aa24eaSPaolo Bonzini alias_target('man', sphinxmans) 116f8aa24eaSPaolo Bonziniendif 117