Changeset 62efd4c in rtems-docs for common/waf.py


Ignore:
Timestamp:
02/19/19 23:11:37 (5 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
5, master
Children:
1a051fc
Parents:
fb72a00
git-author:
Chris Johns <chrisj@…> (02/19/19 23:11:37)
git-committer:
Chris Johns <chrisj@…> (02/27/19 23:22:54)
Message:

waf: Change --sphinx-verbose to --sphinx-options, add --sphinx-nit-pick

Provide options to manage sphinx. Make using the nit-picky mode simpler
to access.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • common/waf.py

    rfb72a00 r62efd4c  
    2828        cfgs += ' -D %s=%s' % (c, configs[c])
    2929    rule = "${BIN_SPHINX_BUILD} %s -b %s -c %s %s -d %s %s %s %s ${SRC}" % \
    30            (sphinx_verbose(ctx), build_type, conf_dir, version_cmdline(ctx),
     30           (sphinx_options(ctx), build_type, conf_dir, version_cmdline(ctx),
    3131            doctrees, cfgs, source_dir, output_dir)
    3232    return rule
     
    112112    return ver
    113113
    114 def sphinx_verbose(ctx):
    115     return ' '.join(ctx.env.SPHINX_VERBOSE)
     114def sphinx_options(ctx):
     115    return ' '.join(ctx.env.SPHINX_OPTIONS)
    116116
    117117def is_top_build(ctx):
     
    200200        ctx.end_msg("yes (%s)" % ".".join(map(str, ver)))
    201201
    202         ctx.start_msg("Checking Sphinx Verbose ")
    203         if 'SPHINX_VERBOSE' not in ctx.env:
    204             ctx.env.append_value('SPHINX_VERBOSE', ctx.options.sphinx_verbose)
    205             level = sphinx_verbose(ctx)
    206             if level == '-Q':
    207                 level = 'quiet'
    208             ctx.end_msg(level)
     202        ctx.start_msg("Checking Sphinx Options ")
     203        if 'SPHINX_OPTIONS' not in ctx.env:
     204            ctx.env.append_value('SPHINX_OPTIONS', ctx.options.sphinx_options)
     205            opts = sphinx_options(ctx)
     206            if len(opts) == 0:
     207                opts = 'none'
     208            ctx.end_msg(opts)
     209
     210        ctx.start_msg("Checking Sphinx Nit-Pick mode ")
     211        if ctx.options.sphinx_nit_pick:
     212            opt = '-n'
     213            msg = 'yes'
     214        else:
     215            opt = '-Q'
     216            msg = 'no'
     217        ctx.env.append_value('SPHINX_OPTIONS', opt)
     218        ctx.end_msg(msg)
     219
    209220        #
    210221        # Check extensions.
     
    429440                   default = False,
    430441                   help = "Disable building with extra fonts for better quality (lower quality).")
    431     ctx.add_option('--sphinx-verbose',
     442    ctx.add_option('--sphinx-options',
    432443                   action = 'store',
    433                    default = "-Q",
    434                    help = "Sphinx verbose.")
     444                   default = "",
     445                   help = "Additional Sphinx options.")
     446    ctx.add_option('--sphinx-nit-pick',
     447                   action = 'store_true',
     448                   default = False,
     449                   help = "Enable Sphinx nit-picky mode else be quiet")
    435450    ctx.add_option('--pdf',
    436451                   action = 'store_true',
Note: See TracChangeset for help on using the changeset viewer.