"""sphinx-polyversion driver for HydroModPy.

Builds the HTML documentation for the published branches and tags into a
single merged site under ``docs/build/html``. That merged tree is what the
Pages deploy publishes at https://docs.hydromodpy.fr/, one folder per version.

Run locally::

    mamba activate hmp_refact
    python -m sphinx_polyversion poly.py

Add ``-l`` (or ``--local``) to render only the current working tree without
checking out any other revision (useful while iterating)::

    python -m sphinx_polyversion poly.py -l
"""

from __future__ import annotations

from pathlib import Path

from sphinx_polyversion import DefaultDriver
from sphinx_polyversion.environment import Environment
from sphinx_polyversion.git import Git, file_predicate
from sphinx_polyversion.sphinx import SphinxBuilder

ROOT = Path(__file__).parent

# Branches whose `docs/source` is built into the merged site. main + dev
# are the current trunks. archive-v1 is the frozen legacy documentation line.
BRANCH_REGEX = r"(main|dev|archive-v1|maint/\d+\.x)"

# Tags follow ``vMAJOR.MINOR.PATCH`` plus optional PEP 440 pre-release suffix.
TAG_REGEX = r"v\d+\.\d+\.\d+(?:a\d+|b\d+|rc\d+)?"

# Only rebuild a revision when files inside the docs source tree changed.
DOCS_SOURCE = "docs/source"

DefaultDriver(
    ROOT,
    ROOT / "docs" / "build" / "html",
    vcs=Git(
        branch_regex=BRANCH_REGEX,
        tag_regex=TAG_REGEX,
        buffer_size=1024 * 1024,
        predicate=file_predicate([DOCS_SOURCE]),
    ),
    builder=SphinxBuilder(
        DOCS_SOURCE,
        args=["-j", "auto", "-b", "html"],
    ),
    env=Environment,
).run()