|
| 1 | +from datetime import datetime |
| 2 | +from functools import partial |
| 3 | +from pathlib import Path |
| 4 | + |
| 5 | +from sphinx_polyversion import apply_overrides |
| 6 | +from sphinx_polyversion.driver import DefaultDriver |
| 7 | +from sphinx_polyversion.git import ( |
| 8 | + Git, |
| 9 | + GitRef, |
| 10 | + GitRefType, |
| 11 | + closest_tag, |
| 12 | + file_predicate, |
| 13 | +) |
| 14 | +from sphinx_polyversion.pyvenv import Pip, VenvWrapper |
| 15 | +from sphinx_polyversion.sphinx import SphinxBuilder |
| 16 | + |
| 17 | +#: Regex matching the branches to build docs for |
| 18 | +BRANCH_REGEX = r"^main$" |
| 19 | + |
| 20 | +#: Regex matching the tags to build docs for |
| 21 | +TAG_REGEX = r"^v\d+\.\d+\.\d+$" |
| 22 | + |
| 23 | +#: Output dir relative to project root |
| 24 | +#: !!! This name has to be choosen !!! |
| 25 | +OUTPUT_DIR = "docs/build" |
| 26 | + |
| 27 | +#: Source directory |
| 28 | +SOURCE_DIR = "docs/" |
| 29 | + |
| 30 | +#: Arguments to pass to `pip install` |
| 31 | +PIP_ARGS = [".[doc]"] |
| 32 | + |
| 33 | +#: Mock data used for building local version |
| 34 | +MOCK_DATA = { |
| 35 | + "revisions": [ |
| 36 | + GitRef( |
| 37 | + name="v0.1.0", |
| 38 | + obj="", |
| 39 | + ref="", |
| 40 | + type_=GitRefType.TAG, |
| 41 | + date=datetime(year=2024, month=2, day=13), |
| 42 | + ) |
| 43 | + ], |
| 44 | + "current": GitRef( |
| 45 | + name="local", |
| 46 | + obj="", |
| 47 | + ref="", |
| 48 | + type_=GitRefType.BRANCH, |
| 49 | + date=datetime.now(), |
| 50 | + ), |
| 51 | +} |
| 52 | + |
| 53 | +#: Whether to build using only local files and mock data |
| 54 | +MOCK = False |
| 55 | + |
| 56 | +# Load overrides read from commandline to global scope |
| 57 | +apply_overrides(globals()) |
| 58 | +# Determine repository root directory |
| 59 | +root = Git.root(Path(__file__).parent) |
| 60 | + |
| 61 | +# Setup driver and run it |
| 62 | +src = Path(SOURCE_DIR) |
| 63 | +ENVIRONMENT = ( |
| 64 | + { |
| 65 | + None: Pip.factory( |
| 66 | + venv=Path(".venv") / "default", |
| 67 | + args=PIP_ARGS, |
| 68 | + creator=VenvWrapper(), |
| 69 | + ), |
| 70 | + "v0.1.0": Pip.factory( |
| 71 | + venv=Path(".venv") / "v0.1.0", |
| 72 | + args=PIP_ARGS |
| 73 | + + [ |
| 74 | + "sphinxcontrib-applehelp<=1.0.4", |
| 75 | + "sphinxcontrib-devhelp<=1.0.2", |
| 76 | + "sphinxcontrib-htmlhelp<=2.0.1", |
| 77 | + "sphinxcontrib-qthelp<=1.0.3", |
| 78 | + "sphinxcontrib-serializinghtml<=1.1.5", |
| 79 | + ], |
| 80 | + creator=VenvWrapper(), |
| 81 | + ), |
| 82 | + "main": Pip.factory( |
| 83 | + venv=Path(".venv") / "main", |
| 84 | + args=PIP_ARGS + ["importlib_metadata"], |
| 85 | + creator=VenvWrapper(), |
| 86 | + ), |
| 87 | + } |
| 88 | + if not MOCK |
| 89 | + else Pip.factory( |
| 90 | + venv=Path(".venv") / "local", |
| 91 | + args=PIP_ARGS + ["importlib_metadata"], |
| 92 | + creator=VenvWrapper(), |
| 93 | + ) |
| 94 | +) |
| 95 | + |
| 96 | +BUILDER = ( |
| 97 | + { |
| 98 | + None: SphinxBuilder(src / "source", args=[]), |
| 99 | + "v0.1.0": SphinxBuilder(src / "source", args=["-D", "plot_gallery=0"]), |
| 100 | + "main": SphinxBuilder(src / "source", args=[]), |
| 101 | + } |
| 102 | + if not MOCK |
| 103 | + else SphinxBuilder(src / "source", args=[]) |
| 104 | +) |
| 105 | + |
| 106 | +DefaultDriver( |
| 107 | + root, |
| 108 | + OUTPUT_DIR, |
| 109 | + vcs=Git( |
| 110 | + branch_regex=BRANCH_REGEX, |
| 111 | + tag_regex=TAG_REGEX, |
| 112 | + buffer_size=1 * 10**9, # 1 GB |
| 113 | + predicate=file_predicate([src]), # exclude refs without source dir |
| 114 | + ), |
| 115 | + builder=BUILDER, |
| 116 | + env=ENVIRONMENT, |
| 117 | + # template_dir=root / src / "templates", |
| 118 | + static_dir=root / src / "source" / "_static", |
| 119 | + mock=MOCK_DATA, |
| 120 | + selector=partial(closest_tag, root), |
| 121 | +).run(MOCK) |
0 commit comments