rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-05 17:22:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

common/waf.py: Add option to check maximum Sphinx version

Browse Source 
Updates #4928.
This commit is contained in:
Joel Sherrill 2023-07-25 15:19:16 -05:00
parent 13237ab34b
commit fbcae10810
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
common/waf.py
View File

@ -16,7 +16,11 @@ from waflib.Build import BuildContext
import latex import latex
import conf import conf
# Sphinx >= 6 are currently broken.
# If you do not want to check for a maximum version, set it to None.
sphinx_min_version = (1, 3) sphinx_min_version = (1, 3)
sphinx_max_version = (5, 9)
#sphinx_max_version = None
def version_cmdline(ctx): def version_cmdline(ctx):
return '-Drelease="%s" -Dversion="%s" -Drtems_major="%s" ' \ return '-Drelease="%s" -Dversion="%s" -Drtems_major="%s" ' \
@ -84,7 +88,7 @@ class linkcheck(BuildContext):
cmd = 'linkcheck' cmd = 'linkcheck'
fun = 'cmd_linkcheck' fun = 'cmd_linkcheck'
def check_sphinx_version(ctx, minver): def check_sphinx_version(ctx, minver, maxver):
try: try:
import sphinx import sphinx
except: except:
@ -115,6 +119,9 @@ def check_sphinx_version(ctx, minver):
ctx.fatal("Sphinx version cannot be checked or Sphinx is not installed") ctx.fatal("Sphinx version cannot be checked or Sphinx is not installed")
if ver < minver: if ver < minver:
ctx.fatal("Sphinx version is too old: %s" % ".".join(map(str, ver))) ctx.fatal("Sphinx version is too old: %s" % ".".join(map(str, ver)))
if maxver is not None:
if ver > maxver:
ctx.fatal("Sphinx version is too new: %s" % ".".join(map(str, ver)))
return ver return ver
def sphinx_options(ctx): def sphinx_options(ctx):
@ -206,8 +213,12 @@ def cmd_configure(ctx):
ctx.find_program("sphinx-build", var="BIN_SPHINX_BUILD", mandatory = True) ctx.find_program("sphinx-build", var="BIN_SPHINX_BUILD", mandatory = True)
ctx.find_program("aspell", var = "BIN_ASPELL", mandatory = False) ctx.find_program("aspell", var = "BIN_ASPELL", mandatory = False)
ctx.start_msg("Checking if Sphinx is at least %s.%s" % sphinx_min_version) if sphinx_max_version is None:
ver = check_sphinx_version(ctx, sphinx_min_version) ctx.start_msg("Checking if Sphinx is at least %s.%s" % sphinx_min_version)
else:
ctx.start_msg("Checking if Sphinx is between %s.%s and %s.%s" % (sphinx_min_version + sphinx_max_version))
ver = check_sphinx_version(ctx, sphinx_min_version, sphinx_max_version)
ctx.end_msg("yes (%s)" % ".".join(map(str, ver))) ctx.end_msg("yes (%s)" % ".".join(map(str, ver)))
ctx.start_msg("Checking Sphinx Options ") ctx.start_msg("Checking Sphinx Options ")