pre-commit/src/cicd_tools_pre_commit/sphinx.py at main · cicd-tools-org/pre-commit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
"""Sphinx related pre-commit scripts."""

import argparse
import os
import sys

from .cli.types import dir_existing, dir_valid, language_code
from .system import call
from .system.fs import rmtree
from .system.git import git_ls_untracked

SPHINX_DEFAULT_GETTEXT_FOLDER = "gettext"
SPHINX_DEFAULT_LOCALES_FOLDER = "locales"
SPHINX_UNTRACKED_FILES_ERROR = "Untracked translation files detected:"


def sphinx_build_language() -> None:
    """Build sphinx documentation for a specific language."""
    parser = argparse.ArgumentParser(
        description="Build sphinx documentation for a specific language.",
        prog="sphinx_build_language",
    )
    parser.add_argument(
        "-b",
        "--build",
        required=True,
        type=dir_valid,
        help="The build folder (can be inside or outside the source folder)",
    )
    parser.add_argument(
        "-l",
        "--language",
        required=True,
        type=language_code,
        help="The target language (e.g. en)",
    )
    parser.add_argument(
        "-s",
        "--source",
        required=True,
        type=dir_existing,
        help="The documentation source folder",
    )

    args = parser.parse_args()

    target_build_folder = os.path.join(args.build, args.language)
    rmtree(target_build_folder)

    os.environ.pop("VIRTUAL_ENV", None)

    call([
        "poetry",
        "run",
        "sphinx-build",
        "-Ea",
        "-b",
        "html",
        "-D",
        f"language={args.language}",
        args.source,
        target_build_folder,
    ])


def sphinx_translate() -> None:
    """Extract translations for sphinx documentation."""
    parser = argparse.ArgumentParser(
        description="Extract translations for sphinx documentation.",
        prog="sphinx_translate",
    )
    parser.add_argument(
        "-b",
        "--build",
        required=True,
        type=dir_valid,
        help="The build folder (can be inside or outside the source folder)",
    )
    parser.add_argument(
        "-g",
        "--gettext",
        default=SPHINX_DEFAULT_GETTEXT_FOLDER,
        required=False,
        type=str,
        help="The build's gettext subfolder",
    )
    parser.add_argument(
        "-l",
        "--locales",
        default=SPHINX_DEFAULT_LOCALES_FOLDER,
        required=False,
        type=str,
        help="The sources's locales subfolder",
    )
    parser.add_argument(
        "-s",
        "--source",
        required=True,
        type=dir_existing,
        help="The documentation source folder",
    )

    args = parser.parse_args()

    gettext_folder = os.path.join(args.build, args.gettext)
    locales_folder = os.path.join(args.source, args.locales)
    rmtree(gettext_folder)

    os.environ.pop("VIRTUAL_ENV", None)

    call([
        "poetry",
        "run",
        "sphinx-build",
        "-b",
        "gettext",
        args.source,
        gettext_folder,
    ])
    call([
        "poetry",
        "run",
        "sphinx-intl",
        "update",
        "-p",
        gettext_folder,
        "-d",
        locales_folder,
    ])

    untracked_files = git_ls_untracked(locales_folder)
    if untracked_files:
        print(SPHINX_UNTRACKED_FILES_ERROR)
        for untracked_file in untracked_files:
            print(f"  {untracked_file}")
        sys.exit(1)