xqemu/docs/devel
Peter Maydell f8cf7147f1 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
2019-03-07 14:26:46 +00:00
..
atomics.txt docs: document atomic_load_acquire and atomic_store_release 2018-03-12 16:12:47 +01:00
blkdebug.txt docs: create config/, devel/ and spin/ subdirectories 2017-06-07 18:22:03 +02:00
blkverify.txt docs: create config/, devel/ and spin/ subdirectories 2017-06-07 18:22:03 +02:00
build-system.txt docs/devel/build-system: fix 'softmu' typo 2018-12-18 14:57:48 +01:00
conf.py docs: Provide separate conf.py for each manual we want 2019-03-07 14:26:46 +00:00
index.rst docs: Provide separate conf.py for each manual we want 2019-03-07 14:26:46 +00:00
loads-stores.rst Rename cpu_physical_memory_write_rom() to address_space_write_rom() 2018-12-14 13:30:48 +00:00
lockcnt.txt docs: fix broken paths to docs/devel/atomics.txt 2017-07-31 13:12:47 +03:00
memory.rst docs: Convert memory.txt to rst format 2019-03-07 14:26:44 +00:00
migration.rst migration: Add post_save function to VMStateDescription 2019-01-21 10:38:55 +00:00
multi-thread-tcg.txt docs: Grammar and spelling fixes 2018-07-13 10:16:04 +01:00
multiple-iothreads.txt docs: mark nested AioContext locking as a legacy API 2017-12-19 10:25:09 +00:00
qapi-code-gen.txt qapi: Generate QAPIEvent stuff into separate files 2019-02-18 14:44:04 +01:00
rcu.txt docs: create config/, devel/ and spin/ subdirectories 2017-06-07 18:22:03 +02:00
stable-process.rst docs: document our stable process 2018-02-19 10:51:16 +01:00
testing.rst docs/devel/testing: Add -a option to usermod command on docker setup 2019-02-11 12:46:59 +00:00
tracing.txt trace: add ability to do simple printf logging via systemtap 2019-01-24 14:16:56 +00:00
virtio-migration.txt docs: create config/, devel/ and spin/ subdirectories 2017-06-07 18:22:03 +02:00
writing-qmp-commands.txt qapi: Move qapi-schema.json to qapi/, rename generated files 2018-03-02 13:45:57 -06:00