Function parse_args

docs/build.py:45–78

(source_args)

    return args, forward_args

def parse_args(source_args):
    def output_format(s):
        if s in OUTPUT_FORMATS:
            return s
        raise ValueError

    parser = argparse.ArgumentParser(usage='%(prog)s [{} ...] [options] [--] [sphinx_options]'.format('|'.join(OUTPUT_FORMATS.keys())), description='''
    DFHack wrapper around sphinx-build.

    Any unrecognized options are passed directly to sphinx-build, as well as any
    options following a '--' argument, if specified.
    ''')
    parser.add_argument('format', nargs='*', type=output_format, action='append',
        help='Documentation format(s) to build - choose from {}'.format(', '.join(OUTPUT_FORMATS.keys())))
    parser.add_argument('-E', '--clean', action='store_true',
        help='Re-read all input files')
    parser.add_argument('--sphinx', type=str, default=os.environ.get('SPHINX', 'sphinx-build'),
        help='Sphinx executable to run [environment variable: SPHINX; default: "sphinx-build"]')
    parser.add_argument('-j', '--jobs', type=str, default=os.environ.get('JOBS', 'auto'),
        help='Number of Sphinx threads to run [environment variable: JOBS; default: "auto"]')
    parser.add_argument('-q', '--quiet', action='store_true',
        help='Disable most output on stdout (also passed to sphinx-build)')
    parser.add_argument('--debug', action='store_true',
        help='Log commands that are run, etc.')
    parser.add_argument('--offline', action='store_true',
        help='Disable network connections')
    args, forward_args = _parse_known_args(parser, source_args)

    # work around weirdness with list args
    args.format = args.format[0]
    if not args.format:
        args.format = ['html']

    return args, forward_args

if __name__ == '__main__':
    os.chdir(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))