tox.ini

[tox]
envlist =
    sphinx


[testenv]
description =
    Common environment.
skip_install = True
whitelist_externals =
    sh
    cp
    rm
    npm
    make
setenv =
    WAMP_BUILD_ID = {env:WAMP_BUILD_ID:00000}
deps =
    # install dev requirements
    -r{toxinidir}/requirements.txt
commands =
    echo "Building with WAMP_BUILD_ID={env:WAMP_BUILD_ID}"


[testenv:sphinx]
description =
    Generate docs using Sphinx.
skip_install = True
passenv =
    HOME
    WAMP_BUILD_ID
commands =
    # regenerate spec in W3C format from .md source files
    npm run build
    make build_images
    make build_spec

    # first test with all warnings fatal
    sphinx-build -nWT -b dummy ./docs ./docs/_build

    # run spell checker
    sphinx-build -b spelling -d ./docs/_build/doctrees ./docs ./docs/_build/spelling

    # generate HTML output
    sphinx-build -b html ./docs ./docs/_build

    # move to HOME to preserve on Travis for upload to S3
    -rm -rf {homedir}/wamp-docs
    cp -R ./docs/_build {homedir}/wamp-docs