FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
sqlmodel/scripts/docs.py at main · Python-Repository-Hub/sqlmodel · GitHub
Python-Repository-Hub
sqlmodel
Repository navigation
Code
Pull requests
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
sqlmodel
/
scripts
/
docs.py
Copy path
More file actions
More file actions
Latest commit
History
History
History
155 lines (126 loc) · 4.56 KB
Breadcrumbs
sqlmodel
/
scripts
/
docs.py
Copy path
File metadata and controls
155 lines (126 loc) · 4.56 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
154
155
import
logging
import
os
import
re
import
subprocess
from
functools
import
lru_cache
from
http
.
server
import
HTTPServer
,
SimpleHTTPRequestHandler
from
importlib
import
metadata
from
pathlib
import
Path
import
mkdocs
.
commands
.
build
import
mkdocs
.
commands
.
serve
import
mkdocs
.
config
import
mkdocs
.
utils
import
typer
from
jinja2
import
Template
logging
.
basicConfig
(
level
=
logging
.
INFO
)
mkdocs_name
=
"mkdocs.yml"
en_docs_path
=
Path
(
""
)
app
=
typer
.
Typer
()
@
lru_cache
def
is_mkdocs_insiders
()
->
bool
:
version
=
metadata
.
version
(
"mkdocs-material"
)
return
"insiders"
in
version
@
app
.
callback
()
def
callback
()
->
None
:
if
is_mkdocs_insiders
():
os
.
environ
[
"INSIDERS_FILE"
]
=
"./mkdocs.insiders.yml"
# For MacOS with insiders and Cairo
os
.
environ
[
"DYLD_FALLBACK_LIBRARY_PATH"
]
=
"/opt/homebrew/lib"
index_sponsors_template
=
"""
{% if sponsors %}
{% for sponsor in sponsors.gold -%}
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}"></a>
{% endfor -%}
{%- for sponsor in sponsors.silver -%}
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}"></a>
{% endfor %}
{% endif %}
"""
def
generate_readme_content
()
->
str
:
en_index
=
en_docs_path
/
"docs"
/
"index.md"
content
=
en_index
.
read_text
(
"utf-8"
)
match_pre
=
re
.
search
(
r"</style>\n\n"
,
content
)
match_start
=
re
.
search
(
r"<!-- sponsors -->"
,
content
)
match_end
=
re
.
search
(
r"<!-- /sponsors -->"
,
content
)
sponsors_data_path
=
en_docs_path
/
"data"
/
"sponsors.yml"
sponsors
=
mkdocs
.
utils
.
yaml_load
(
sponsors_data_path
.
read_text
(
encoding
=
"utf-8"
))
if
not
(
match_start
and
match_end
):
raise
RuntimeError
(
"Couldn't auto-generate sponsors section"
)
if
not
match_pre
:
raise
RuntimeError
(
"Couldn't find pre section (<style>) in index.md"
)
frontmatter_end
=
match_pre
.
end
()
pre_end
=
match_start
.
end
()
post_start
=
match_end
.
start
()
template
=
Template
(
index_sponsors_template
)
message
=
template
.
render
(
sponsors
=
sponsors
)
pre_content
=
content
[
frontmatter_end
:
pre_end
]
post_content
=
content
[
post_start
:]
new_content
=
pre_content
+
message
+
post_content
return
new_content
@
app
.
command
()
def
generate_readme
()
->
None
:
"""
Generate README.md content from main index.md
"""
typer
.
echo
(
"Generating README"
)
readme_path
=
Path
(
"README.md"
)
new_content
=
generate_readme_content
()
readme_path
.
write_text
(
new_content
,
encoding
=
"utf-8"
)
@
app
.
command
()
def
verify_readme
()
->
None
:
"""
Verify README.md content from main index.md
"""
typer
.
echo
(
"Verifying README"
)
readme_path
=
Path
(
"README.md"
)
generated_content
=
generate_readme_content
()
readme_content
=
readme_path
.
read_text
(
"utf-8"
)
if
generated_content
!=
readme_content
:
typer
.
secho
(
"README.md outdated from the latest index.md"
,
color
=
typer
.
colors
.
RED
)
raise
typer
.
Abort
()
typer
.
echo
(
"Valid README ✅"
)
@
app
.
command
()
def
live
()
->
None
:
"""
Serve with livereload a docs site for a specific language.
This only shows the actual translated files, not the placeholders created with
build-all.
Takes an optional LANG argument with the name of the language to serve, by default
en.
"""
# Enable line numbers during local development to make it easier to highlight
os
.
environ
[
"LINENUMS"
]
=
"true"
mkdocs
.
commands
.
serve
.
serve
(
dev_addr
=
"127.0.0.1:8008"
)
@
app
.
command
()
def
build
()
->
None
:
"""
Build the docs.
"""
insiders_env_file
=
os
.
environ
.
get
(
"INSIDERS_FILE"
)
print
(
f"Insiders file
{
insiders_env_file
}
"
)
if
is_mkdocs_insiders
():
print
(
"Using insiders"
)
print
(
"Building docs"
)
subprocess
.
run
([
"mkdocs"
,
"build"
],
check
=
True
)
typer
.
secho
(
"Successfully built docs"
,
color
=
typer
.
colors
.
GREEN
)
@
app
.
command
()
def
serve
()
->
None
:
"""
A quick server to preview a built site.
For development, prefer the command live (or just mkdocs serve).
This is here only to preview the documentation site.
Make sure you run the build command first.
"""
typer
.
echo
(
"Warning: this is a very simple server."
)
typer
.
echo
(
"For development, use the command live instead."
)
typer
.
echo
(
"This is here only to preview the documentation site."
)
typer
.
echo
(
"Make sure you run the build command first."
)
os
.
chdir
(
"site"
)
server_address
=
(
""
,
8008
)
server
=
HTTPServer
(
server_address
,
SimpleHTTPRequestHandler
)
typer
.
echo
(
"Serving at: http://127.0.0.1:8008"
)
server
.
serve_forever
()
if
__name__
==
"__main__"
:
app
()
Back
|
FazBrowse Home
|
New Git URL