gdnative-doc 0.0.6

Documentation tool for gdnative
Documentation 
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

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
@author: arnaudgolfouse
@brief:  script that get godot classes for the 3.2, 3.3, 3.4 and 3.5 branches. Note that this is probably not portable :/
"""

# %%
import subprocess
import os
from pathlib import Path

GODOT_REPOSITORY_URL = "https://github.com/godotengine/godot"
GODOT_REPOSITORY_PATH = "godot"
CLASSES_PATH = "doc/classes"
VERSIONS = ["3.2", "3.3", "3.4", "3.5"]


script_path = Path(__file__).absolute().parent
os.chdir(script_path)

if not Path(GODOT_REPOSITORY_PATH).exists():
    os.mkdir(GODOT_REPOSITORY_PATH)
    os.chdir(GODOT_REPOSITORY_PATH)

    subprocess.call(["git", "init"])

    git_remote_add_args = ["git", "remote", "add"]
    for version in VERSIONS:
        git_remote_add_args.append("-t")
        git_remote_add_args.append(version)
    git_remote_add_args.append("origin")
    git_remote_add_args.append(GODOT_REPOSITORY_URL)
    subprocess.call(git_remote_add_args)

    subprocess.call(["git", "fetch", "--depth", "1"])

os.chdir(script_path)

for version in VERSIONS:
    godot_classes_file: str = f"godot_classes-{version}.txt"

    # change branch
    os.chdir(GODOT_REPOSITORY_PATH)
    subprocess.call(["git", "checkout", version])

    # get those files
    classes_names = []
    for file in Path(CLASSES_PATH).glob("*"):
        file_name = file.name
        if (not file_name.startswith("@")) and file_name.endswith(".xml"):
            classes_names.append(file_name[:-4])
    classes_names.sort()
    os.chdir(script_path)

    file_content = "// This file was automatically generated from the file names at " + \
        GODOT_REPOSITORY_URL + "/tree/" + version + "/doc/classes\n"
    file_content += "[\n"
    for class_name in classes_names:
        file_content += f"    \"{class_name}\",\n"
    file_content += "]"
    file_path = Path(godot_classes_file).absolute()
    file_path.write_text(file_content)