noxfile.py

"""Build the documentation in isolated environment

The nox run are build in isolated environment that will be stored in .nox. to force the venv update, remove the .nox/xxx folder.
"""

import nox


@nox.session
def compile(session):
    """Build the modules files from the module documentation"""
    session.install("-r", "requirements.txt")
    session.run("python", "docs/source/_script/modules.py")
    session.run("python", "docs/source/_script/environment.py")


@nox.session(name="docs", reuse_venv=True)
def docs(session):
    """Build the documentation."""
    builder = session.posargs[0] if len(session.posargs) > 0 else "html"
    session.install("-r", "requirements.txt")
    session.run(
        "sphinx-build",
        "-b",
        builder,
        "docs/source",
        f"docs/build/{builder}",
        "-w",
        "warnings.txt",
    )
    session.run("python", "tests/check_warnings.py")


@nox.session(name="i18n", reuse_venv=True)
def i18n(session):
    """Create the translation files"""
    supported_languages = ["en", "fr", "es", "ar", "pt", "zh", "ru", "sv", "it"]
    session.install("-r", "requirements.txt")
    session.install("sphinx", "sphinx-intl")
    session.run("sphinx-build", "-b", "gettext", "docs/source", "docs/build/gettext")
    session.run(
        "sphinx-intl",
        "update",
        "-p",
        "docs/build/gettext",
        "--locale-dir",
        "docs/source/_locale",
        *[f"--language={i}" for i in supported_languages],
    )


@nox.session(name="lint", reuse_venv=True)
def lint(session):
    """Lint the documentation repository"""
    session.install("pre-commit")
    session.run("pre-commit", "run", "-a")