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() 122e880198SDaniel P. Berrangé SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build, '-q'] 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 3073e6aec6SMarc-André Lureau warning('@0@: @1@'.format(sphinx_build.full_path(), sphinx_build_test_out.stderr())) 31e3667660SYonggang Luo if get_option('docs').enabled() 3273e6aec6SMarc-André Lureau error('Install a Python 3 version of python-sphinx and the readthedoc theme') 33e3667660SYonggang Luo endif 34e3667660SYonggang Luo endif 35e3667660SYonggang Luoendif 36e3667660SYonggang Luo 37f8aa24eaSPaolo Bonziniif build_docs 38e3667660SYonggang Luo SPHINX_ARGS += ['-Dversion=' + meson.project_version(), '-Drelease=' + config_host['PKGVERSION']] 39e3667660SYonggang Luo 40654d6b04SPaolo Bonzini sphinx_extn_depends = [ meson.current_source_dir() / 'sphinx/depfile.py', 41654d6b04SPaolo Bonzini meson.current_source_dir() / 'sphinx/hxtool.py', 42654d6b04SPaolo Bonzini meson.current_source_dir() / 'sphinx/kerneldoc.py', 43654d6b04SPaolo Bonzini meson.current_source_dir() / 'sphinx/kernellog.py', 44654d6b04SPaolo Bonzini meson.current_source_dir() / 'sphinx/qapidoc.py', 45654d6b04SPaolo Bonzini meson.current_source_dir() / 'sphinx/qmp_lexer.py', 46e3667660SYonggang Luo qapi_gen_depends ] 47654d6b04SPaolo Bonzini sphinx_template_files = [ meson.project_source_root() / 'docs/_templates/footer.html' ] 48e3667660SYonggang Luo 49e0f7fc58SStefan Reiter have_ga = have_tools and config_host.has_key('CONFIG_GUEST_AGENT') 50e0f7fc58SStefan Reiter 51f8aa24eaSPaolo Bonzini man_pages = { 52e0f7fc58SStefan Reiter 'qemu-ga.8': (have_ga ? 'man8' : ''), 53e0f7fc58SStefan Reiter 'qemu-ga-ref.7': (have_ga ? 'man7' : ''), 544ac2ee19SPeter Maydell 'qemu-qmp-ref.7': 'man7', 5523c02aceSStefan Hajnoczi 'qemu-storage-daemon-qmp-ref.7': (have_tools ? 'man7' : ''), 56f8aa24eaSPaolo Bonzini 'qemu-img.1': (have_tools ? 'man1' : ''), 57f8aa24eaSPaolo Bonzini 'qemu-nbd.8': (have_tools ? 'man8' : ''), 58773ee3f1SPeter Maydell 'qemu-pr-helper.8': (have_tools ? 'man8' : ''), 59fa56cf7eSPeter Maydell 'qemu-storage-daemon.1': (have_tools ? 'man1' : ''), 60*9c29b741SPaolo Bonzini 'qemu-trace-stap.1': (stap.found() ? 'man1' : ''), 61f8aa24eaSPaolo Bonzini 'virtfs-proxy-helper.1': (have_virtfs_proxy_helper ? 'man1' : ''), 62f8aa24eaSPaolo Bonzini 'virtiofsd.1': (have_virtiofsd ? 'man1' : ''), 63f8aa24eaSPaolo Bonzini 'qemu.1': 'man1', 64f8aa24eaSPaolo Bonzini 'qemu-block-drivers.7': 'man7', 65f8aa24eaSPaolo Bonzini 'qemu-cpu-models.7': 'man7' 66f8aa24eaSPaolo Bonzini } 67f8aa24eaSPaolo Bonzini 68f8aa24eaSPaolo Bonzini sphinxdocs = [] 69f8aa24eaSPaolo Bonzini sphinxmans = [] 70bac35bf5SPaolo Bonzini 71b93f4fbdSPeter Maydell private_dir = meson.current_build_dir() / 'manual.p' 72b93f4fbdSPeter Maydell output_dir = meson.current_build_dir() / 'manual' 73b93f4fbdSPeter Maydell input_dir = meson.current_source_dir() 74b93f4fbdSPeter Maydell 75b93f4fbdSPeter Maydell this_manual = custom_target('QEMU manual', 76f8aa24eaSPaolo Bonzini build_by_default: build_docs, 77b93f4fbdSPeter Maydell output: 'docs.stamp', 78b93f4fbdSPeter Maydell input: files('conf.py'), 79b93f4fbdSPeter Maydell depfile: 'docs.d', 8013f934e7SPeter Maydell depend_files: [ sphinx_extn_depends, sphinx_template_files ], 81bac35bf5SPaolo Bonzini command: [SPHINX_ARGS, '-Ddepfile=@DEPFILE@', 82bac35bf5SPaolo Bonzini '-Ddepfile_stamp=@OUTPUT0@', 83bac35bf5SPaolo Bonzini '-b', 'html', '-d', private_dir, 84bac35bf5SPaolo Bonzini input_dir, output_dir]) 85bac35bf5SPaolo Bonzini sphinxdocs += this_manual 86b93f4fbdSPeter Maydell install_subdir(output_dir, install_dir: qemu_docdir, strip_directory: true) 87f8aa24eaSPaolo Bonzini 88f8aa24eaSPaolo Bonzini these_man_pages = [] 89f8aa24eaSPaolo Bonzini install_dirs = [] 90b93f4fbdSPeter Maydell foreach page, section : man_pages 91f8aa24eaSPaolo Bonzini these_man_pages += page 92f8aa24eaSPaolo Bonzini install_dirs += section == '' ? false : get_option('mandir') / section 93f8aa24eaSPaolo Bonzini endforeach 94b93f4fbdSPeter Maydell 95b93f4fbdSPeter Maydell sphinxmans += custom_target('QEMU man pages', 96f8aa24eaSPaolo Bonzini build_by_default: build_docs, 97f8aa24eaSPaolo Bonzini output: these_man_pages, 98bac35bf5SPaolo Bonzini input: this_manual, 99f8aa24eaSPaolo Bonzini install: build_docs, 100f8aa24eaSPaolo Bonzini install_dir: install_dirs, 101f8aa24eaSPaolo Bonzini command: [SPHINX_ARGS, '-b', 'man', '-d', private_dir, 102f8aa24eaSPaolo Bonzini input_dir, meson.current_build_dir()]) 103b93f4fbdSPeter Maydell 104f8aa24eaSPaolo Bonzini alias_target('sphinxdocs', sphinxdocs) 1054ac2ee19SPeter Maydell alias_target('html', sphinxdocs) 106f8aa24eaSPaolo Bonzini alias_target('man', sphinxmans) 107f8aa24eaSPaolo Bonziniendif 108