gdnative-doc 0.0.2

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

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

# %%
import subprocess
import os
from pathlib import Path

GODOT_REPOSITORY_URL = "https://github.com/godotengine/godot"
BRANCH = "3.2"
GODOT_REPOSITORY_PATH = "godot"
CLASSES_PATH = "doc/classes"
GODOT_CLASSES_FILE = "godot_classes" + "-" + BRANCH + ".txt"

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

# clone if not already done
if not Path(GODOT_REPOSITORY_PATH).exists():
    subprocess.call(["git", "clone", "--no-checkout", "--branch", BRANCH,
                     "--single-branch", "--depth", "1", GODOT_REPOSITORY_URL, GODOT_REPOSITORY_PATH])

# sparse checkout
os.chdir(GODOT_REPOSITORY_PATH)
subprocess.call(["git", "sparse-checkout", "init", "--cone"])
subprocess.call(["git", "sparse-checkout", "set", CLASSES_PATH])

# get those files
file_content = "// This file was automatically generated from the file names at " + \
    GODOT_REPOSITORY_URL + "/tree/" + BRANCH + "/doc/classes\n"
file_content += "[\n"
for file in Path(CLASSES_PATH).glob("*"):
    file_name = file.name
    if (not file_name.startswith("@")) and file_name.endswith(".xml"):
        file_content += "    \""
        file_name = file_name[:-4]
        file_content += file_name
        file_content += "\",\n"
file_content += "]"
Path("../" + GODOT_CLASSES_FILE).write_text(file_content)