2020-08-05 15:49:10 +02:00
|
|
|
if build_docs
|
|
|
|
configure_file(output: 'index.html',
|
|
|
|
input: files('index.html.in'),
|
|
|
|
configuration: {'VERSION': meson.project_version()},
|
2020-08-26 13:04:17 +02:00
|
|
|
install_dir: qemu_docdir)
|
2020-08-05 15:49:10 +02:00
|
|
|
manuals = [ 'devel', 'interop', 'tools', 'specs', 'system', 'user' ]
|
|
|
|
man_pages = {
|
|
|
|
'interop' : {
|
|
|
|
'qemu-ga.8': (have_tools ? 'man8' : ''),
|
2020-09-25 18:23:03 +02:00
|
|
|
'qemu-ga-ref.7': 'man7',
|
docs/interop: Convert qemu-qmp-ref to rST
Convert qemu-qmp-ref to rST format. This includes dropping
the plain-text, pdf and info format outputs for this document;
as with all our other Sphinx-based documentation, we provide
HTML and manpage only.
The qemu-qmp-ref.rst is somewhat more stripped down than
the .texi was, because we do not (currently) attempt to
generate indexes for the commands, events and data types
being documented.
Again, we drop the direct link from index.html.in now that
the QMP ref is part of the interop manual.
This commit removes the code from the root meson.build file that
handled the various Texinfo-based outputs, because we no longer
generate any documentation except for the Sphinx HTML manuals and the
manpages, and the code can't handle having an empty list of files
to process.. We'll do further cleanup of the remainders of
Texinfo support in subsequent commits.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-10-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Unicode legacy literal dumbed down to plain string literal, TODO
comment on displaying QEMU version added, "make html" fixed,
storage-daemon/qapi/meson.build updated]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2020-09-25 18:23:04 +02:00
|
|
|
'qemu-qmp-ref.7': 'man7',
|
2020-08-05 15:49:10 +02:00
|
|
|
},
|
|
|
|
'tools': {
|
|
|
|
'qemu-img.1': (have_tools ? 'man1' : ''),
|
|
|
|
'qemu-nbd.8': (have_tools ? 'man8' : ''),
|
|
|
|
'qemu-trace-stap.1': (config_host.has_key('CONFIG_TRACE_SYSTEMTAP') ? 'man1' : ''),
|
|
|
|
'virtfs-proxy-helper.1': (have_virtfs_proxy_helper ? 'man1' : ''),
|
|
|
|
'virtiofsd.1': (have_virtiofsd ? 'man1' : ''),
|
|
|
|
},
|
|
|
|
'system': {
|
|
|
|
'qemu.1': 'man1',
|
|
|
|
'qemu-block-drivers.7': 'man7',
|
|
|
|
'qemu-cpu-models.7': 'man7'
|
|
|
|
},
|
|
|
|
}
|
|
|
|
|
|
|
|
sphinxdocs = []
|
|
|
|
sphinxmans = []
|
|
|
|
foreach manual : manuals
|
|
|
|
private_dir = meson.current_build_dir() / (manual + '.p')
|
2020-08-11 09:07:04 +02:00
|
|
|
output_dir = meson.current_build_dir() / manual
|
2020-08-05 15:49:10 +02:00
|
|
|
input_dir = meson.current_source_dir() / manual
|
2020-08-11 09:07:04 +02:00
|
|
|
|
|
|
|
this_manual = custom_target(manual + ' manual',
|
2020-08-05 15:49:10 +02:00
|
|
|
build_by_default: build_docs,
|
2020-08-11 09:07:04 +02:00
|
|
|
output: [manual + '.stamp'],
|
|
|
|
input: [files('conf.py'), files(manual / 'conf.py')],
|
|
|
|
depfile: manual + '.d',
|
2020-09-25 18:23:09 +02:00
|
|
|
depend_files: sphinx_extn_depends,
|
2020-08-11 09:07:04 +02:00
|
|
|
command: [SPHINX_ARGS, '-Ddepfile=@DEPFILE@',
|
|
|
|
'-Ddepfile_stamp=@OUTPUT0@',
|
|
|
|
'-b', 'html', '-d', private_dir,
|
|
|
|
input_dir, output_dir])
|
|
|
|
sphinxdocs += this_manual
|
2020-08-05 15:49:10 +02:00
|
|
|
if build_docs and manual != 'devel'
|
2020-08-26 13:04:17 +02:00
|
|
|
install_subdir(output_dir, install_dir: qemu_docdir)
|
2020-08-05 15:49:10 +02:00
|
|
|
endif
|
|
|
|
|
|
|
|
these_man_pages = []
|
|
|
|
install_dirs = []
|
|
|
|
foreach page, section : man_pages.get(manual, {})
|
|
|
|
these_man_pages += page
|
|
|
|
install_dirs += section == '' ? false : get_option('mandir') / section
|
|
|
|
endforeach
|
|
|
|
if these_man_pages.length() > 0
|
|
|
|
sphinxmans += custom_target(manual + ' man pages',
|
|
|
|
build_by_default: build_docs,
|
|
|
|
output: these_man_pages,
|
2020-08-11 09:07:04 +02:00
|
|
|
input: this_manual,
|
2020-08-05 15:49:10 +02:00
|
|
|
install: build_docs,
|
|
|
|
install_dir: install_dirs,
|
|
|
|
command: [SPHINX_ARGS, '-b', 'man', '-d', private_dir,
|
|
|
|
input_dir, meson.current_build_dir()])
|
|
|
|
endif
|
|
|
|
endforeach
|
|
|
|
alias_target('sphinxdocs', sphinxdocs)
|
docs/interop: Convert qemu-qmp-ref to rST
Convert qemu-qmp-ref to rST format. This includes dropping
the plain-text, pdf and info format outputs for this document;
as with all our other Sphinx-based documentation, we provide
HTML and manpage only.
The qemu-qmp-ref.rst is somewhat more stripped down than
the .texi was, because we do not (currently) attempt to
generate indexes for the commands, events and data types
being documented.
Again, we drop the direct link from index.html.in now that
the QMP ref is part of the interop manual.
This commit removes the code from the root meson.build file that
handled the various Texinfo-based outputs, because we no longer
generate any documentation except for the Sphinx HTML manuals and the
manpages, and the code can't handle having an empty list of files
to process.. We'll do further cleanup of the remainders of
Texinfo support in subsequent commits.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-10-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Unicode legacy literal dumbed down to plain string literal, TODO
comment on displaying QEMU version added, "make html" fixed,
storage-daemon/qapi/meson.build updated]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2020-09-25 18:23:04 +02:00
|
|
|
alias_target('html', sphinxdocs)
|
2020-08-05 15:49:10 +02:00
|
|
|
alias_target('man', sphinxmans)
|
|
|
|
endif
|