-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathupdate_mkdocs_yml.py
More file actions
executable file
·153 lines (140 loc) · 5.49 KB
/
Copy pathupdate_mkdocs_yml.py
File metadata and controls
executable file
·153 lines (140 loc) · 5.49 KB
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
#!/usr/bin/env python3
import sys
import yaml
if len(sys.argv) < 3:
print("Missing required arguments to update_mkdocs_yml.py.\n")
print("Usage:\n")
print(" update_mkdocs_yml.py <SITE_URL> <DOCS_DIR>\n")
exit(1)
site_url = sys.argv[1]
docs_dir = sys.argv[2]
with open("mkdocs.yml") as f:
mkdocs = yaml.load(f, Loader=yaml.SafeLoader)
mkdocs["site_url"] = site_url
mkdocs["edit_uri"] = 'edit/main/{}/'.format(docs_dir)
mkdocs["markdown_extensions"] = [
{
"markdown.extensions.codehilite": {
"use_pygments": False
}
},
"markdown.extensions.attr_list",
"markdown.extensions.md_in_html",
"markdown.extensions.def_list",
"pymdownx.superfences",
"pymdownx.tabbed",
{
"pymdownx.snippets": {
"url_download": True,
"base_path": [
"docs/snippets"
]
}
},
{
"toc": {
"toc_depth": 2
}
},
"callouts"
]
mkdocs["theme"] = {
"name": None,
"custom_dir": "documentation-theme/theme",
"static_templates": [
"pages/404.html"
]
}
mkdocs["extra"]["dotkernel_discussions_url"] = "https://github.com/orgs/dotkernel/discussions"
mkdocs["extra"]["dotkernel_blog_url"] = "https://www.dotkernel.com/blog/"
mkdocs["extra"]["dotkernel_rss_url"] = "https://www.dotkernel.com/feed/"
mkdocs["extra"]["docs_api_url"] = "https://docs.dotkernel.org/api-documentation/"
mkdocs["extra"]["docs_admin_url"] = "https://docs.dotkernel.org/admin-documentation/"
mkdocs["extra"]["docs_frontend_url"] = "https://docs.dotkernel.org/frontend-documentation/"
mkdocs["extra"]["docs_light_url"] = "https://docs.dotkernel.org/light-documentation/"
mkdocs["extra"]["docs_queue_url"] = "https://docs.dotkernel.org/queue-documentation/"
mkdocs["extra"]["docs_packages_url"] = "https://docs.dotkernel.org/packages/"
mkdocs["extra"]["docs_development_url"] = "https://docs.dotkernel.org/development/"
mkdocs["extra"]["docs_headless_url"] = "https://docs.dotkernel.org/headless-documentation/"
mkdocs["extra"]["docs_dotboost_url"] = "https://docs.dotkernel.org/dotboost/"
# Remove any trailing slashes from the end of the repo_url
mkdocs["repo_url"] = mkdocs["repo_url"].rstrip("/")
mkdocs["extra"]["repo_name"] = mkdocs["repo_url"].replace("https://github.com/", "")
mkdocs["extra"]["base_url"] = "https://docs.dotkernel.org/"
if mkdocs["extra"]["project"] == "API":
mkdocs["extra"]["project_url"] = mkdocs["extra"]["docs_api_url"]
elif mkdocs["extra"]["project"] == "Admin":
mkdocs["extra"]["project_url"] = mkdocs["extra"]["docs_admin_url"]
elif mkdocs["extra"]["project"] == "Frontend":
mkdocs["extra"]["project_url"] = mkdocs["extra"]["docs_frontend_url"]
elif mkdocs["extra"]["project"] == "Light":
mkdocs["extra"]["project_url"] = mkdocs["extra"]["docs_light_url"]
elif mkdocs["extra"]["project"] == "Queue":
mkdocs["extra"]["project_url"] = mkdocs["extra"]["docs_queue_url"]
elif mkdocs["extra"]["project"] == "Packages":
mkdocs["extra"]["project_url"] = mkdocs["extra"]["docs_packages_url"]
elif mkdocs["extra"]["project"] == "Development":
mkdocs["extra"]["project_url"] = mkdocs["extra"]["docs_development_url"]
elif mkdocs["extra"]["project"] == "Headless Platform":
mkdocs["extra"]["project_url"] = mkdocs["extra"]["docs_headless_url"]
elif mkdocs["extra"]["project"] == "Dotboost":
mkdocs["extra"]["project_url"] = mkdocs["extra"]["docs_dotboost_url"]
mkdocs["extra"]["projects"] = [
{
"name": "API",
"description": "Dotkernel API",
"docs_url": mkdocs["extra"]["docs_api_url"],
},
{
"name": "Admin",
"description": "Dotkernel Admin",
"docs_url": mkdocs["extra"]["docs_admin_url"],
},
{
"name": "Frontend",
"description": "Dotkernel Frontend",
"docs_url": mkdocs["extra"]["docs_frontend_url"],
},
{
"name": "Light",
"description": "Dotkernel Light",
"docs_url": mkdocs["extra"]["docs_light_url"],
},
{
"name": "Queue",
"description": "Dotkernel Queue",
"docs_url": mkdocs["extra"]["docs_queue_url"],
},
{
"name": "Packages",
"description": "Dotkernel packages",
"docs_url": mkdocs["extra"]["docs_packages_url"],
},
{
"name": "Development",
"description": "Development Environment using AlmaLinux",
"docs_url": mkdocs["extra"]["docs_development_url"],
},
{
"name": "Headless Platform",
"description": "Dotkernel Headless Platform",
"docs_url": mkdocs["extra"]["docs_headless_url"],
},
{
"name": "Dotboost",
"description": "Claude Code configuration for Dotkernel projects",
"docs_url": mkdocs["extra"]["docs_dotboost_url"],
},
]
mkdocs["extra"].setdefault("development", {})
mkdocs["extra"]["development"].setdefault("versions", [])
mkdocs["extra"]["development"].setdefault("version_mapping", {})
mkdocs["extra"]["development"]["versions"] = ["v1", "v2"]
mkdocs["extra"]["development"]["version_mapping"]["v1"] = "AlmaLinux 9"
mkdocs["extra"]["development"]["version_mapping"]["v2"] = "AlmaLinux 10"
# If plugins are set, check if search exists
# https://www.mkdocs.org/user-guide/configuration/#plugins
if "plugins" in mkdocs and not "search" in mkdocs["plugins"]:
mkdocs["plugins"].append("search")
with open("mkdocs.yml", "w") as f:
yaml.dump(mkdocs, f, default_flow_style=False)