diff options
author | Peter Maydell <peter.maydell@linaro.org> | 2019-03-07 14:26:46 +0000 |
---|---|---|
committer | Peter Maydell <peter.maydell@linaro.org> | 2019-03-07 14:26:46 +0000 |
commit | f8cf7147f10a3cee64396614218b08e3c9161d4a (patch) | |
tree | 0bde08436f950ce50eb3da5f660ca3befc3933e4 /docs/index.rst | |
parent | e250e867dc0172203b30aa25032efe29f1102b21 (diff) | |
download | qemu-f8cf7147f10a3cee64396614218b08e3c9161d4a.zip qemu-f8cf7147f10a3cee64396614218b08e3c9161d4a.tar.gz qemu-f8cf7147f10a3cee64396614218b08e3c9161d4a.tar.bz2 |
docs: Provide separate conf.py for each manual we want
By default Sphinx wants to build a single manual at once.
For QEMU, this doesn't suit us, because we want to have
separate manuals for "Developer's Guide", "User Manual",
and so on, and we don't want to ship the Developer's Guide
to end-users. However, we don't want to completely duplicate
conf.py for each manual, and we'd like to continue to
support "build all docs in one run" for third-party sites
like readthedocs.org.
Make the top-level conf.py support two usage forms:
(1) as a common config file which is included by the conf.py
for each of QEMU's manuals: in this case sphinx-build is run
multiple times, once per subdirectory.
(2) as a top level conf file which will result in building all
the manuals into a single document: in this case sphinx-build is
run once, on the top-level docs directory.
Provide per-manual conf.py files and top level pages for
our first two manuals:
* QEMU Developer's Guide (docs/devel)
* QEMU System Emulation Management and Interoperability Guide
(docs/interop)
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Acked-by: Aleksandar Markovic <amarkovic@wavecomp.com>
Message-id: 20190305172139.32662-9-peter.maydell@linaro.org
Message-id: 20190228145624.24885-9-peter.maydell@linaro.org
Diffstat (limited to 'docs/index.rst')
-rw-r--r-- | docs/index.rst | 9 |
1 files changed, 2 insertions, 7 deletions
diff --git a/docs/index.rst b/docs/index.rst index 93f8222..3690955 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,11 +10,6 @@ Welcome to QEMU's documentation! :maxdepth: 2 :caption: Contents: + interop/index + devel/index - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` |