Example #1
0
File: userdoc.py Project: AvdN/tdi
def sphinx(**kwargs):
    """ Run sphinx """
    prog = _shell.frompath('sphinx-build')
    if prog is None:
        _term.red("sphinx-build not found")
        return False

    env = dict(_os.environ)

    argv = [
        prog, '-a',
        '-d', _os.path.join(kwargs['build'], 'doctrees'),
        '-b', 'html',
        kwargs['source'],
        kwargs['target'],
    ]

    return not _shell.spawn(*argv, **{'env': env})
Example #2
0
def sphinx(**kwargs):
    """ Run sphinx """
    prog = _shell.frompath('sphinx-build')
    if prog is None:
        _term.red("sphinx-build not found")
        return False

    env = dict(_os.environ)

    argv = [
        prog, '-a',
        '-d', _os.path.join(kwargs['build'], 'doctrees'),
        '-b', 'html',
        kwargs['source'],
        kwargs['target'],
    ]

    return not _shell.spawn(*argv, **{'env': env})
Example #3
0
def sphinx(**kwargs):
    """ Run sphinx """
    prog = _shell.frompath("sphinx-build")
    if prog is None:
        _term.red("sphinx-build not found")
        return False

    env = dict(_os.environ)

    argv = [
        prog,
        "-a",
        "-d",
        _os.path.join(kwargs["build"], "doctrees"),
        "-b",
        "html",
        kwargs["source"],
        kwargs["target"],
    ]

    return not _shell.spawn(*argv, **{"env": env})
Example #4
0
File: apidoc.py Project: AvdN/tdi
def epydoc(**kwargs):
    """ Run epydoc """
    # pylint: disable = R0912
    prog = kwargs.get('epydoc') or 'epydoc'
    if not _os.path.dirname(_os.path.normpath(prog)):
        prog = _shell.frompath(prog)
    if not prog:
        _term.red("%(epydoc)s not found",
            epydoc=kwargs.get('epydoc') or 'epydoc',
        )
        return False

    version = _VERSION_SEARCH(_shell.spawn(prog, "--version", stdout=True))
    if version is not None:
        try:
            version = tuple(map(int, version.group('major', 'minor')))
        except (TypeError, ValueError):
            version = None
    if version is None:
        _term.red("%(prog)s version not recognized" % locals())
        return False

    if version < (3, 0):
        _term.red("%(prog)s is too old %(version)r < (3, 0)" % locals())
        return False

    env = dict(_os.environ)

    prepend = kwargs.get('prepend')
    if prepend:
        toprepend = _os.pathsep.join(map(str, prepend))
        if 'PYTHONPATH' in env:
            env['PYTHONPATH'] = _os.pathsep.join((
                toprepend, env['PYTHONPATH']
            ))
        else:
            env['PYTHONPATH'] = toprepend

    append = kwargs.get('append')
    if append:
        toappend = _os.pathsep.join(map(str, append))
        if 'PYTHONPATH' in env:
            env['PYTHONPATH'] = _os.pathsep.join((
                env['PYTHONPATH'], toappend
            ))
        else:
            env['PYTHONPATH'] = toappend

    moreenv = kwargs.get('env')
    if moreenv:
        env.update(moreenv)

    config = kwargs.get('config') or _shell.native('docs/epydoc.conf')

    argv = [prog, '--config', config]
    res = not _shell.spawn(*argv, **{'env': env})
    if res:
        cfg = _util.SafeConfigParser()
        cfg.read(config)
        try:
            target = dict(cfg.items('epydoc'))['target']
        except KeyError:
            pass
        else:
            _cleanup_epydoc(target)
    return res
Example #5
0
File: _make.py Project: AvdN/tdi
def warn(message, name=None):
    """ Warn """
    _term.red("%(NAME)sWarning: %(msg)s",
        NAME=name and "%s:" % name or '', msg=message
    )
Example #6
0
def warn(message, name=None):
    """ Warn """
    _term.red("%(NAME)sWarning: %(msg)s",
              NAME=name and "%s:" % name or '',
              msg=message)
Example #7
0
def epydoc(**kwargs):
    """ Run epydoc """
    # pylint: disable = R0912
    prog = kwargs.get('epydoc') or 'epydoc'
    if not _os.path.dirname(_os.path.normpath(prog)):
        prog = _shell.frompath(prog)
    if not prog:
        _term.red("%(epydoc)s not found",
            epydoc=kwargs.get('epydoc') or 'epydoc',
        )
        return False

    version = _VERSION_SEARCH(_shell.spawn(prog, "--version", stdout=True))
    if version is not None:
        try:
            version = tuple(map(int, version.group('major', 'minor')))
        except (TypeError, ValueError):
            version = None
    if version is None:
        _term.red("%(prog)s version not recognized" % locals())
        return False

    if version < (3, 0):
        _term.red("%(prog)s is too old %(version)r < (3, 0)" % locals())
        return False

    env = dict(_os.environ)

    prepend = kwargs.get('prepend')
    if prepend:
        toprepend = _os.pathsep.join(map(str, prepend))
        if 'PYTHONPATH' in env:
            env['PYTHONPATH'] = _os.pathsep.join((
                toprepend, env['PYTHONPATH']
            ))
        else:
            env['PYTHONPATH'] = toprepend

    append = kwargs.get('append')
    if append:
        toappend = _os.pathsep.join(map(str, append))
        if 'PYTHONPATH' in env:
            env['PYTHONPATH'] = _os.pathsep.join((
                env['PYTHONPATH'], toappend
            ))
        else:
            env['PYTHONPATH'] = toappend

    moreenv = kwargs.get('env')
    if moreenv:
        env.update(moreenv)

    config = kwargs.get('config') or _shell.native('docs/epydoc.conf')

    argv = [prog, '--config', config]
    res = not _shell.spawn(*argv, **{'env': env})
    if res:
        cfg = _util.SafeConfigParser()
        cfg.read(config)
        try:
            target = dict(cfg.items('epydoc'))['target']
        except KeyError:
            pass
        else:
            _cleanup_epydoc(target)
    return res