[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 11/12] docs/conf.py: Don't hard-code QEMU version
From: |
Peter Maydell |
Subject: |
[Qemu-devel] [PULL 11/12] docs/conf.py: Don't hard-code QEMU version |
Date: |
Thu, 7 Mar 2019 15:24:49 +0000 |
Don't hard-code the QEMU version number into conf.py. Instead
we either pass it to sphinx-build on the command line, or
(if doing a standalone Sphinx run in a readthedocs.org setup)
extract it from the VERSION file.
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Reviewed-by: Philippe Mathieu-Daudé <address@hidden>
Tested-by: Philippe Mathieu-Daudé <address@hidden>
Acked-by: Aleksandar Markovic <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
Message-id: address@hidden
Message-id: address@hidden
---
Makefile | 2 +-
docs/conf.py | 21 ++++++++++++++++-----
2 files changed, 17 insertions(+), 6 deletions(-)
diff --git a/Makefile b/Makefile
index b746d112a7f..cad585b4d6b 100644
--- a/Makefile
+++ b/Makefile
@@ -869,7 +869,7 @@ docs/version.texi: $(SRC_PATH)/VERSION
sphinxdocs: docs/devel/index.html docs/interop/index.html
# Canned command to build a single manual
-build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -b html -d
.doctrees/$1 $(SRC_PATH)/docs/$1 docs/$1 ,"SPHINX","docs/$1")
+build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -b html -D
version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1
$(SRC_PATH)/docs/$1 docs/$1 ,"SPHINX","docs/$1")
# We assume all RST files in the manual's directory are used in it
manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst)
$(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py
diff --git a/docs/conf.py b/docs/conf.py
index f452e424cfe..befbcc6c3e1 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -76,11 +76,22 @@ author = u'The QEMU Project Developers'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
-#
-# The short X.Y version.
-version = u'4.0'
-# The full version, including alpha/beta/rc tags.
-release = u'4.0'
+
+# Extract this information from the VERSION file, for the benefit of
+# standalone Sphinx runs as used by readthedocs.org. Builds run from
+# the Makefile will pass version and release on the sphinx-build
+# command line, which override this.
+try:
+ extracted_version = None
+ with open(os.path.join(qemu_docdir, '../VERSION')) as f:
+ extracted_version = f.readline().strip()
+except:
+ pass
+finally:
+ if extracted_version:
+ version = release = extracted_version
+ else:
+ version = release = "unknown version"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
--
2.20.1
- [Qemu-devel] [PULL 00/12] sphinx queue, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 01/12] docs/cpu-hotplug.rst: Fix rST markup issues, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 02/12] docs: Convert memory.txt to rst format, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 04/12] docs/conf.py: Disable unused _static directory, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 05/12] docs/conf.py: Configure the 'alabaster' theme, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 07/12] docs/conf.py: Disable option warnings, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 06/12] docs/conf.py: Don't include rST sources in HTML build, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 03/12] docs: Commit initial files from sphinx-quickstart, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 10/12] Makefile: Abstract out "identify the pkgversion" code, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 09/12] Makefile, configure: Support building rST documentation, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 11/12] docs/conf.py: Don't hard-code QEMU version,
Peter Maydell <=
- [Qemu-devel] [PULL 08/12] docs: Provide separate conf.py for each manual we want, Peter Maydell, 2019/03/07
- [Qemu-devel] [PULL 12/12] MAINTAINERS: Add entry for Sphinx documentation infrastructure, Peter Maydell, 2019/03/07
- Re: [Qemu-devel] [PULL 00/12] sphinx queue, no-reply, 2019/03/07
- Re: [Qemu-devel] [PULL 00/12] sphinx queue, Peter Maydell, 2019/03/07
- Re: [Qemu-devel] [PULL 00/12] sphinx queue, no-reply, 2019/03/07