qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Qemu-devel] [PATCH v3 00/12] Enable build and install of our rST docs


From: Peter Maydell
Subject: [Qemu-devel] [PATCH v3 00/12] Enable build and install of our rST docs
Date: Tue, 5 Mar 2019 17:21:27 +0000

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




reply via email to

[Prev in Thread] Current Thread [Next in Thread]