-
Notifications
You must be signed in to change notification settings - Fork 14.1k
/
dev_index_generator.py
84 lines (67 loc) · 2.82 KB
/
dev_index_generator.py
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
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations
import argparse
import os
import sys
from glob import glob
import jinja2
# isort:off (needed to workaround isort bug)
from docs.exts.provider_yaml_utils import load_package_data
# isort:on (needed to workaround isort bug)
CURRENT_DIR = os.path.abspath(os.path.dirname(__file__))
DOCS_DIR = os.path.abspath(os.path.join(CURRENT_DIR, os.pardir, os.pardir))
BUILD_DIR = os.path.abspath(os.path.join(DOCS_DIR, "_build"))
ALL_PROVIDER_YAMLS = load_package_data()
def _get_jinja_env():
loader = jinja2.FileSystemLoader(CURRENT_DIR, followlinks=True)
env = jinja2.Environment(loader=loader, undefined=jinja2.StrictUndefined)
return env
def _render_template(template_name, **kwargs):
return _get_jinja_env().get_template(template_name).render(**kwargs)
def _render_content():
provider_packages = [
os.path.basename(os.path.dirname(p)) for p in glob(f"{BUILD_DIR}/docs/apache-airflow-providers-*/")
]
providers = []
for package_name in provider_packages:
try:
current_provider = next(
provider_yaml
for provider_yaml in ALL_PROVIDER_YAMLS
if provider_yaml["package-name"] == package_name
)
providers.append(current_provider)
except StopIteration:
print(f"WARNING! Could not find provider.yaml file for package: {package_name}")
content = _render_template(
"dev_index_template.html.jinja2", providers=sorted(providers, key=lambda k: k["package-name"])
)
return content
def generate_index(out_file: str) -> None:
"""
Generates an index for development documentation.
:param out_file: The path where the index should be stored
"""
content = _render_content()
with open(out_file, "w") as output_file:
output_file.write(content)
if __name__ == "__main__":
parser = argparse.ArgumentParser()
parser.add_argument("outfile", nargs="?", type=argparse.FileType("w"), default=sys.stdout)
args = parser.parse_args()
args.outfile.write(_render_content())