From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Cc: "Philippe Mathieu-Daudé" <philmd@redhat.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Aleksandar Markovic" <amarkovic@wavecomp.com>
Subject: [Qemu-devel] [PATCH v3 00/12] Enable build and install of our rST docs
Date: Tue, 5 Mar 2019 17:21:27 +0000 [thread overview]
Message-ID: <20190305172139.32662-1-peter.maydell@linaro.org> (raw)
This patchset enables building and installing the various rST
docs we have started to accumulate in our docs/ directory.
Version 3 is almost the same as version 2: the only
differences are:
* patch 5 enabling the Alabaster theme also adds
"needs_sphinx = '1.3'" to docs/conf.py, since that is
where the Alabaster theme was added to Sphinx proper
* patch 9 has a new has_sphinx_build() function which
specifically tests that sphinx-build can handle our
conf.py, rather than just testing the executable
is present
* patch 9 adds /.doctrees to the .gitignore
* patch 12 is new and provides a MAINTAINERS entry
for the conf.py files (ie the build infrastructure,
as distinct from the content)
I figured the changes in patches 5 and 9 were small enough
that I've kept the various reviewed/tested/etc tags.
thanks
-- PMM
Peter Maydell (12):
docs/cpu-hotplug.rst: Fix rST markup issues
docs: Convert memory.txt to rst format
docs: Commit initial files from sphinx-quickstart
docs/conf.py: Disable unused _static directory
docs/conf.py: Configure the 'alabaster' theme
docs/conf.py: Don't include rST sources in HTML build
docs/conf.py: Disable option warnings
docs: Provide separate conf.py for each manual we want
Makefile, configure: Support building rST documentation
Makefile: Abstract out "identify the pkgversion" code
docs/conf.py: Don't hard-code QEMU version
MAINTAINERS: Add entry for Sphinx documentation infrastructure
configure | 15 +-
Makefile | 78 +++++++---
.gitignore | 1 +
MAINTAINERS | 6 +
docs/conf.py | 216 ++++++++++++++++++++++++++
docs/cpu-hotplug.rst | 2 +-
docs/devel/conf.py | 15 ++
docs/devel/index.rst | 21 +++
docs/devel/{memory.txt => memory.rst} | 128 ++++++++-------
docs/index.rst | 15 ++
docs/interop/conf.py | 15 ++
docs/interop/index.rst | 18 +++
12 files changed, 449 insertions(+), 81 deletions(-)
create mode 100644 docs/conf.py
create mode 100644 docs/devel/conf.py
create mode 100644 docs/devel/index.rst
rename docs/devel/{memory.txt => memory.rst} (85%)
create mode 100644 docs/index.rst
create mode 100644 docs/interop/conf.py
create mode 100644 docs/interop/index.rst
--
2.20.1
next reply other threads:[~2019-03-05 17:21 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-05 17:21 Peter Maydell [this message]
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 01/12] docs/cpu-hotplug.rst: Fix rST markup issues Peter Maydell
2019-03-05 22:34 ` Richard Henderson
2019-03-07 0:04 ` Cleber Rosa
2019-03-07 9:47 ` Peter Maydell
2019-03-07 11:15 ` Cleber Rosa
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 02/12] docs: Convert memory.txt to rst format Peter Maydell
2019-03-05 22:40 ` Richard Henderson
2019-03-07 0:11 ` Cleber Rosa
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 03/12] docs: Commit initial files from sphinx-quickstart Peter Maydell
2019-03-05 22:36 ` Richard Henderson
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 04/12] docs/conf.py: Disable unused _static directory Peter Maydell
2019-03-05 22:36 ` Richard Henderson
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 05/12] docs/conf.py: Configure the 'alabaster' theme Peter Maydell
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 06/12] docs/conf.py: Don't include rST sources in HTML build Peter Maydell
2019-03-05 22:42 ` Richard Henderson
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 07/12] docs/conf.py: Disable option warnings Peter Maydell
2019-03-05 22:42 ` Richard Henderson
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 08/12] docs: Provide separate conf.py for each manual we want Peter Maydell
2019-03-07 1:40 ` Cleber Rosa
2019-03-07 9:49 ` Peter Maydell
2019-03-07 12:14 ` Cleber Rosa
2019-03-07 12:29 ` Peter Maydell
2019-03-07 13:18 ` Cleber Rosa
2019-03-07 13:30 ` Peter Maydell
2019-03-07 13:41 ` Cleber Rosa
2019-03-07 13:46 ` Peter Maydell
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 09/12] Makefile, configure: Support building rST documentation Peter Maydell
2019-03-05 22:45 ` Richard Henderson
[not found] ` <92ffba93-e486-647a-01ef-86180fb2cbb2@redhat.com>
2019-04-01 7:58 ` Peter Maydell
2019-04-01 12:51 ` Eric Blake
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 10/12] Makefile: Abstract out "identify the pkgversion" code Peter Maydell
2019-03-05 22:33 ` Richard Henderson
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 11/12] docs/conf.py: Don't hard-code QEMU version Peter Maydell
2019-03-05 22:46 ` Richard Henderson
2019-03-05 17:21 ` [Qemu-devel] [PATCH v3 12/12] MAINTAINERS: Add entry for Sphinx documentation infrastructure Peter Maydell
2019-03-05 18:08 ` Philippe Mathieu-Daudé
2019-03-05 22:47 ` Richard Henderson
2019-03-05 17:44 ` [Qemu-devel] [PATCH v3 00/12] Enable build and install of our rST docs no-reply
2019-03-05 18:17 ` no-reply
2019-03-06 1:28 ` no-reply
2019-03-06 1:32 ` no-reply
2019-03-07 0:10 ` no-reply
2019-03-07 0:15 ` no-reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190305172139.32662-1-peter.maydell@linaro.org \
--to=peter.maydell@linaro.org \
--cc=alex.bennee@linaro.org \
--cc=amarkovic@wavecomp.com \
--cc=philmd@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.