summaryrefslogtreecommitdiffstats
path: root/common
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2020-03-12 16:34:16 +1100
committerChris Johns <chrisj@rtems.org>2020-03-13 08:18:36 +1100
commit19af6b47d54b802da6a144dbf4008c75cd2fa073 (patch)
tree0ad3c8667924b29e9b48d8f6c418429bc74b7531 /common
parentuser: Add anchors to some BSPs. (diff)
downloadrtems-docs-19af6b47d54b802da6a144dbf4008c75cd2fa073.tar.bz2
waf: Get the version numbers from the version file.
Diffstat (limited to 'common')
-rw-r--r--common/conf.py15
-rw-r--r--common/version.py25
-rw-r--r--common/waf.py5
3 files changed, 40 insertions, 5 deletions
diff --git a/common/conf.py b/common/conf.py
index fe44640..97f8dfa 100644
--- a/common/conf.py
+++ b/common/conf.py
@@ -1,7 +1,10 @@
+import version as rtems_version
+
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.doctest",
+ "sphinx.ext.extlinks",
"sphinx.ext.graphviz",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
@@ -9,6 +12,8 @@ extensions = [
"rtemsdomain",
]
+extlinks = {'release_path': ('https://ftp.rtems.org/pub/rtems/releases', None) }
+
# Add any paths that contain templates here, relative to this directory.
#templates_path = ['build/_templates']
@@ -23,17 +28,21 @@ master_doc = 'index'
# General information about the project.
project = u'RTEMS Documentation Project'
-copyright = u'1988, 2019 RTEMS Project and contributors'
+copyright = u'1988, 2020 RTEMS Project and contributors'
# 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 = '@VERSION@'
+version = rtems_version.version()
# The full version, including alpha/beta/rc tags.
-#release = '@RELEASE@'
+release = rtems_version.string()
+
+major = rtems_version.major()
+minor = rtems_version.minor()
+revision = rtems_version.revision()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/common/version.py b/common/version.py
index 9beb3e7..281c880 100644
--- a/common/version.py
+++ b/common/version.py
@@ -1,6 +1,6 @@
#
# RTEMS Documentation Project (http://www.rtems.org/)
-# Copyright 2019 Chris Johns (chrisj@rtems.org)
+# Copyright 2019, 2020 Chris Johns (chrisj@rtems.org)
# Copyright (C) 2019 embedded brains GmbH
# All rights reserved.
#
@@ -66,6 +66,9 @@ from __future__ import print_function
import os.path
_version = 'invalid'
+_major = 0
+_minor = 0
+_revision = 0
_date = 'unknown date'
_released = False
@@ -155,6 +158,17 @@ def get(ctx, rtems_major_version):
_version = version
_date = date
_release = released
+ if version != 'invalid':
+ vs = _version.split('.')
+ _major = vs[0]
+ if len(vs) == 3:
+ _minor = vs[1]
+ _revision = vs[2]
+ elif len(vs) == 2:
+ _minor = 0
+ _revision = vs[1]
+ else:
+ ctx.fatal('Invalid version format: %s' % (_version))
return version, date, released
def string():
@@ -163,6 +177,15 @@ def string():
def version():
return _version
+def major():
+ return _major
+
+def minor():
+ return _minor
+
+def revision():
+ return revision
+
def date():
return _date
diff --git a/common/waf.py b/common/waf.py
index 066048d..36feef5 100644
--- a/common/waf.py
+++ b/common/waf.py
@@ -19,7 +19,10 @@ import conf
sphinx_min_version = (1, 3)
def version_cmdline(ctx):
- return '-Drelease="%s" -Dversion="%s"' % (ctx.env.RELEASE, ctx.env.VERSION)
+ return '-Drelease="%s" -Dversion="%s" -Drtems_major="%s" ' \
+ '-Drtems_minor="%s" -D rtems_revision="%s"' \
+ % (ctx.env.RELEASE, ctx.env.VERSION, ctx.env.RTEMS_MAJOR,
+ ctx.env.RTEMS_MINOR, ctx.env.RTEMS_REVISION)
def sphinx_cmdline(ctx, build_type, conf_dir, doctrees,
source_dir, output_dir, configs = []):