summaryrefslogtreecommitdiff
path: root/server/continuedev/models/reference/generate.py
blob: 43e88750e419d79b98d2b2612ad5c5ca53c9441e (plain)
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
import html
import importlib
import json
from textwrap import dedent

LLM_MODULES = [
    ("llamacpp", "LlamaCpp"),
    ("ollama", "Ollama"),
    ("queued", "QueuedLLM")
]

CONTEXT_PROVIDER_MODULES = [
    ("diff", "DiffContextProvider"),
    ("file", "FileContextProvider"),
    ("filetree", "FileTreeContextProvider"),
    ("github", "GitHubIssuesContextProvider"),
    ("google", "GoogleContextProvider"),
    ("search", "SearchContextProvider"),
    ("terminal", "TerminalContextProvider"),
    ("url", "URLContextProvider"),
]


def import_llm_module(module_name, module_title):
    module_name = f"continuedev.libs.llm.{module_name}"
    module = importlib.import_module(module_name)
    obj = getattr(module, module_title)
    return obj


def import_context_provider_module(module_name, module_title):
    module_name = f"continuedev.plugins.context_providers.{module_name}"
    module = importlib.import_module(module_name)
    obj = getattr(module, module_title)
    return obj


def docs_from_schema(schema, filepath, ignore_properties=[], inherited=[]):
    # Generate markdown docs
    properties = ""
    inherited_properties = ""

    def add_property(prop, details, only_required):
        required = prop in schema.get("required", [])
        if only_required != required or prop in ignore_properties:
            return ""
        required = "true" if required else "false"
        return f"""<ClassPropertyRef name='{prop}' details='{html.escape(json.dumps(details))}' required={{{required}}} default="{html.escape(str(details.get("default", "")))}"/>\n"""

    for prop, details in schema["properties"].items():
        property = add_property(prop, details, True)
        if prop in inherited:
            inherited_properties += property
        else:
            properties += property

    for prop, details in schema["properties"].items():
        property = add_property(prop, details, False)
        if prop in inherited:
            inherited_properties += property
        else:
            properties += property

    return dedent(
        f"""\
import ClassPropertyRef from '@site/src/components/ClassPropertyRef.tsx';

# {schema['title']}

{dedent(schema.get("description", ""))}

[View the source](https://github.com/continuedev/continue/tree/main/server/continuedev/{filepath})

## Properties

{properties}

### Inherited Properties

{inherited_properties}"""
    )


llm_module = importlib.import_module("continuedev.libs.llm.base")
ctx_obj = getattr(llm_module, "LLM")
schema = ctx_obj.schema()
ctx_properties = schema["properties"].keys()

for module_name, module_title in LLM_MODULES:
    obj = import_llm_module(module_name, module_title)
    schema = obj.schema()
    markdown_docs = docs_from_schema(
        schema, f"libs/llm/{module_name}.py", inherited=ctx_properties
    )
    with open(f"docs/docs/reference/Models/{module_title.lower()}.md", "w") as f:
        f.write(markdown_docs)

config_module = importlib.import_module("continuedev.core.config")
config_obj = getattr(config_module, "ContinueConfig")
schema = config_obj.schema()
markdown_docs = docs_from_schema(schema, "core/config.py")
with open("docs/docs/reference/config.md", "w") as f:
    f.write(markdown_docs)

ctx_module = importlib.import_module("continuedev.core.context")
ctx_obj = getattr(ctx_module, "ContextProvider")
schema = ctx_obj.schema()
ctx_properties = schema["properties"].keys()
for module_name, module_title in CONTEXT_PROVIDER_MODULES:
    obj = import_context_provider_module(module_name, module_title)
    schema = obj.schema()
    markdown_docs = docs_from_schema(
        schema,
        f"plugins/context_providers/{module_name}.py",
        ignore_properties=[
            "sdk",
            "updated_documents",
            "delete_documents",
            "selected_items",
            "ignore_patterns",
        ],
        inherited=ctx_properties,
    )
    with open(
        f"docs/docs/reference/Context Providers/{module_title.lower()}.md", "w"
    ) as f:
        f.write(markdown_docs)

# sdk_module = importlib.import_module("continuedev.core.sdk")
# sdk_obj = getattr(sdk_module, "ContinueSDK")
# schema = sdk_obj.schema()
# markdown_docs = docs_from_schema(schema, "sdk", ignore_properties=[])
# with open("docs/docs/reference/ContinueSDK.md", "w") as f:
#     f.write(markdown_docs)