|author||Peter Maydell <firstname.lastname@example.org>||2019-02-28 14:56:24 +0000|
|committer||Peter Maydell <email@example.com>||2019-03-05 12:46:25 +0000|
docs/conf.py: Don't hard-code QEMU versionpull-sphinx-20190305
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 <firstname.lastname@example.org> Reviewed-by: Alex Bennée <email@example.com> Reviewed-by: Philippe Mathieu-Daudé <firstname.lastname@example.org> Tested-by: Philippe Mathieu-Daudé <email@example.com> Acked-by: Aleksandar Markovic <firstname.lastname@example.org> Message-id: email@example.com
Diffstat (limited to 'docs/conf.py')
1 files changed, 16 insertions, 5 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 6a334f545e..0842d44e93 100644
@@ -75,11 +75,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.
+ extracted_version = None
+ with open(os.path.join(qemu_docdir, '../VERSION')) as f:
+ extracted_version = f.readline().strip()
+ if extracted_version:
+ version = release = extracted_version
+ version = release = "unknown version"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.