Changeset 2a06644 in rtems-docs

Timestamp:

02/22/18 16:23:08 (5 years ago)

Author:

Richard Campbell <richard.campbell@…>

Branches:

5, am, master

Children:

0472ead

Parents:

9c9ba8f

git-author:

Richard Campbell <richard.campbell@…> (02/22/18 16:23:08)

git-committer:

Joel Sherrill <joel@…> (03/09/18 19:28:45)

Message:

RTEMS Docs: Check sphinx version

Sphinx.util.compat module was removed at Sphinx version 1.7.
Imported module was not being used.

Closes #3311.

Location:

common

Files:

• rtemsdomain.py (modified) (1 diff)
• waf.py (modified) (1 diff)

common/rtemsdomain.py

@@ -7 +7 @@
 from sphinx.directives import ObjectDescription
 from sphinx.domains import Domain, ObjType, Index
-from sphinx.util.compat import Directive
 from sphinx.util.nodes import make_refnode
 from sphinx.util.docfields import Field, TypedField

common/waf.py

@@ -82 +82 @@
 
 def check_sphinx_version(ctx, minver):
-    version = ctx.cmd_and_log(ctx.env.BIN_SPHINX_BUILD +
+    try:
+        import sphinx
+        # sphinx.version_info was introduced in sphinx ver 1.2
+        version = sphinx.version_info
+        # version looks like (1, 7, 0, 'final', 0))
+        ver = version[0:2]
+    except:
+        try:
+            # sphinx-build returns its version info in stderr
+            (out, err) = ctx.cmd_and_log(ctx.env.BIN_SPHINX_BUILD +
+                              ['--version'], output=Context.BOTH)
+            # err looks like 'sphinx-build 1.7.0\n'
+            version = err.split(" ")[-1:][0].strip()
+            ver = tuple(map(int, re.split('[\D]', version)))
+        except:
+            try:
+                # sphinx-build returns its version info in stdout
+                version = ctx.cmd_and_log(ctx.env.BIN_SPHINX_BUILD +
                               ['--version']).split(" ")[-1:][0].strip()
-    try:
-        ver = tuple(map(int, re.split('[\D]', version)))
-    except:
-        ctx.fatal("Sphinx version cannot be checked: %s" % version)
+                try:
+                    ver = tuple(map(int, re.split('[\D]', version)))
+                except:
+                    ctx.fatal("Sphinx version cannot be checked")
+            except:
+                ctx.fatal("Sphinx version cannot be checked: %s" % version)
     if ver < minver:
         ctx.fatal("Sphinx version is too old: %s" % ".".join(map(str, ver)))