tox.ini

# To use tox, see https://tox.readthedocs.io
# Simply pip or conda install tox
# If you use conda, you may also want to install tox-conda

[tox]
envlist = docs-clean

[testenv]
basepython = python3
skip_install = true

[testenv:notebooks]
description = convert and execute the querying notebook
# Note this requires that a database already be set up at AIIDA_PATH, and run:
# verdi archive import https://object.cscs.ch/v1/AUTH_b1d80408b3d340db9f03d373bbde5c1e/marvel-vms/tutorials/aiida_tutorial_2020_07_perovskites_v0.9.aiida
passenv = AIIDA_PATH
deps =
    aiida-core~=1.6.4
    aiida-quantumespresso
    ipykernel
    ipython
    jupytext
    matplotlib
    nbconvert
    numpy
commands_pre = reentry scan -r aiida
commands =
    jupytext --from myst --to ipynb --execute --output docs/sections/managing_data/querying-executed.ipynb docs/sections/managing_data/querying.md

[testenv:docs-{update,clean}]
description =
    clean: Build the documentation (remove any existing build)
    update: Build the documentation (modify any existing build)
deps = -rrequirements.txt
whitelist_externals =
    rm
    echo
commands =
    clean: rm -rf docs/_build
    sphinx-build -nW --keep-going -b {posargs:html} docs/ docs/_build/{posargs:html}
commands_post = echo "open file://{toxinidir}/docs/_build/{posargs:html}/index.html"

[testenv:docs-live]
description = Build the documentation and launch browser
deps =
    -rrequirements.txt
    sphinx-autobuild
commands =
    sphinx-autobuild \
        --re-ignore _build/.* \
        --port 0 --open-browser \
        -n -b {posargs:html} docs/ docs/_build/{posargs:html}