diff options
author | Peter Maydell <peter.maydell@linaro.org> | 2019-02-28 14:56:24 +0000 |
---|---|---|
committer | Peter Maydell <peter.maydell@linaro.org> | 2019-03-05 12:46:25 +0000 |
commit | 0ae1f22330b1416fd03308ae0de960351afdafed (patch) | |
tree | 4f35fce991cc1e585bce612f3b99eb0cb9dcfe92 /docs/conf.py | |
parent | 479f831441ec932d7478aaaa225a46018e410794 (diff) | |
download | qemu-arm-0ae1f22330b1416fd03308ae0de960351afdafed.tar.gz |
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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Acked-by: Aleksandar Markovic <amarkovic@wavecomp.com>
Message-id: 20190228145624.24885-12-peter.maydell@linaro.org
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/docs/conf.py b/docs/conf.py index 6a334f545e..0842d44e93 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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. +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. |