mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-08-02 23:33:54 -06:00
docs: Generate qemu.1 manpage with Sphinx
Generate the qemu.1 manpage using Sphinx; we do this with a new top-level rst source file which is just the skeleton of the manpage and which includes .rst.inc fragments where it needs to incorporate sections from the larger HTML manuals. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Tested-by: Alex Bennée <alex.bennee@linaro.org> Message-id: 20200228153619.9906-30-peter.maydell@linaro.org
This commit is contained in:
parent
bf87bef091
commit
d06118bfbd
3 changed files with 51 additions and 6 deletions
|
@ -17,6 +17,8 @@ html_theme_options['description'] = u'System Emulation User''s Guide'
|
|||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('qemu-manpage', 'qemu', u'QEMU User Documentation',
|
||||
['Fabrice Bellard'], 1),
|
||||
('qemu-block-drivers', 'qemu-block-drivers',
|
||||
u'QEMU block drivers reference',
|
||||
['Fabrice Bellard and the QEMU Project developers'], 7),
|
||||
|
|
45
docs/system/qemu-manpage.rst
Normal file
45
docs/system/qemu-manpage.rst
Normal file
|
@ -0,0 +1,45 @@
|
|||
:orphan:
|
||||
|
||||
..
|
||||
This file is the skeleton for the qemu.1 manpage. It mostly
|
||||
should simply include the .rst.inc files corresponding to the
|
||||
parts of the documentation that go in the manpage as well as the
|
||||
HTML manual.
|
||||
|
||||
Title
|
||||
=====
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| [options] [disk_image]
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
.. include:: target-i386-desc.rst.inc
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
disk_image is a raw hard disk image for IDE hard disk 0. Some targets do
|
||||
not need a disk image.
|
||||
|
||||
.. hxtool-doc:: qemu-options.hx
|
||||
|
||||
.. include:: keys.rst.inc
|
||||
|
||||
.. include:: mux-chardev.rst.inc
|
||||
|
||||
Notes
|
||||
-----
|
||||
|
||||
.. include:: device-url-syntax.rst.inc
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
The HTML documentation of QEMU for more precise information and Linux
|
||||
user mode emulator invocation.
|
Loading…
Add table
Add a link
Reference in a new issue