pavement.py

# Copyright (c) 2017 Adi Roiban.
# See LICENSE for details.
"""
Build script for Python binary distribution.
"""
import os
import sys
from paver.easy import path, task


@task
def deps():
    """
    Copy external dependencies.
    """
    print('Installing dependencies to ...')
    from pip import main
    main(args=['install', '-r', 'docs/requirements.txt'])


def _run_sphinx(args):
    """
    Run sphinx build with `args`.
    """
    from sphinx.cmd.build import main
    main(args)


@task
def build():
    """
    Generate the site as local static files.
    """
    build_html = os.path.join(os.getcwd(), 'build', 'html')

    # Works: sphinx-build -b html -j 2 -n -W docs/ build/html/
    _run_sphinx(['-b', 'html', '-j', '2', '-n', '-W', 'docs/', build_html])
    print("Open the result in a browser: file://%s/index.html" % build_html)


@task
def test():
    """
    Run a few tests.
    """
    build_errors = os.path.join(os.getcwd(), 'build', 'errors')
    path(build_errors).remove()

    build_html = os.path.join(os.getcwd(), 'build', 'html')
    _run_sphinx([
        '-b', 'html',
        '-j', '2',
        '-Ean', '-w', build_errors,
        'docs/', build_html,
        ])
    errors = open(build_errors, 'r').read()
    if errors:
        print('Errors summary:\n\n')
        print(errors)
        sys.exit(1)