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
|
#!/usr/bin/env python3
from pathlib import Path
import shutil
import textwrap
from jinja2 import Environment
from jinja2 import FileSystemLoader
from markupsafe import Markup
import pygments.formatters.html
import pygments.lexers.python
import pdoc.render
here = Path(__file__).parent
if __name__ == "__main__":
demo = here / ".." / "test" / "testdata" / "demo.py"
env = Environment(
loader=FileSystemLoader([here, here / ".." / "pdoc" / "templates"]),
autoescape=True,
)
lexer = pygments.lexers.python.PythonLexer()
formatter = pygments.formatters.html.HtmlFormatter(style="friendly")
pygments_css = formatter.get_style_defs()
example_html = Markup(pygments.highlight(demo.read_text("utf8"), lexer, formatter))
(here / "index.html").write_bytes(
env.get_template("index.html.jinja2")
.render(
example_html=example_html,
pygments_css=pygments_css,
__version__=pdoc.__version__,
)
.encode()
)
if (here / "docs").is_dir():
shutil.rmtree(here / "docs")
# Render standalone demo (without any configuration)
pdoc.pdoc(
demo,
output_directory=here / "docs",
)
(here / "docs" / "demo.html").rename(here / "docs" / "demo-standalone.html")
# Render main docs
pdoc.render.configure(
edit_url_map={
"pdoc": "https://github.com/mitmproxy/pdoc/blob/main/pdoc/",
"demo": "https://github.com/mitmproxy/pdoc/blob/main/test/testdata/demo",
"demo_long": "https://github.com/mitmproxy/pdoc/blob/main/test/testdata/demo_long",
},
favicon="/favicon.svg",
logo="/logo.svg",
logo_link="https://pdoc.dev",
footer_text=f"pdoc {pdoc.__version__}",
)
pdoc.pdoc(
"pdoc",
demo,
here / ".." / "test" / "testdata" / "demo_long.py",
output_directory=here / "docs",
)
# Render dark mode example
pdoc.render.configure(template_directory=here / ".." / "examples" / "dark-mode")
pdoc.pdoc(demo, output_directory=here / "docs" / "dark-mode")
# Render math example
pdoc.render.configure(
math=True,
logo="/logo.svg",
logo_link="https://pdoc.dev",
edit_url_map={
"math_demo": "https://github.com/mitmproxy/pdoc/blob/main/test/testdata/math_demo"
},
)
pdoc.pdoc(
here / ".." / "test" / "testdata" / "math_demo.py",
output_directory=here / "docs" / "math",
)
# Render mermaid example
pdoc.render.configure(
mermaid=True,
logo="/logo.svg",
logo_link="https://pdoc.dev",
edit_url_map={
"math_demo": "https://github.com/mitmproxy/pdoc/blob/main/test/testdata/mermaid_demo"
},
)
pdoc.pdoc(
here / ".." / "test" / "testdata" / "mermaid_demo.py",
output_directory=here / "docs" / "mermaid",
)
# Add sitemap.xml
with (here / "sitemap.xml").open("w", newline="\n") as f:
f.write(
textwrap.dedent(
"""
<?xml version="1.0" encoding="utf-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
"""
).strip()
)
for file in here.glob("**/*.html"):
if file.name.startswith("_"):
continue
filename = str(file.relative_to(here).as_posix()).replace("index.html", "")
f.write(f"""\n<url><loc>https://pdoc.dev/{filename}</loc></url>""")
f.write("""\n</urlset>""")
|
