mirror of
https://github.com/vee1e/mitmproxy.git
synced 2026-09-02 18:57:22 +00:00
6269898b43
* docs: improve accessibility * docs: source section name from `_index.md` files * add JSON search index * add pizza search * Revert "add pizza search" This reverts commit 5b5da7d2c2b9cb11919e35cfab9bda19f5651896. * add search index * add search bar * update CHANGELOG * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
82 lines
1.8 KiB
Python
82 lines
1.8 KiB
Python
#!/usr/bin/env python3
|
|
import os
|
|
import shutil
|
|
import textwrap
|
|
from pathlib import Path
|
|
|
|
import pdoc.render_helpers
|
|
|
|
here = Path(__file__).parent
|
|
|
|
if os.environ.get("DOCS_ARCHIVE", False):
|
|
edit_url_map = {}
|
|
else:
|
|
edit_url_map = {
|
|
"mitmproxy": "https://github.com/mitmproxy/mitmproxy/blob/main/mitmproxy/",
|
|
}
|
|
|
|
pdoc.render.configure(
|
|
template_directory=here / "pdoc-template",
|
|
edit_url_map=edit_url_map,
|
|
search=False,
|
|
)
|
|
# We can't configure Hugo, but we can configure pdoc.
|
|
pdoc.render_helpers.formatter.cssclass = "chroma pdoc-code"
|
|
|
|
modules = [
|
|
"mitmproxy.addonmanager",
|
|
"mitmproxy.certs",
|
|
"mitmproxy.connection",
|
|
"mitmproxy.coretypes.multidict",
|
|
"mitmproxy.dns",
|
|
"mitmproxy.flow",
|
|
"mitmproxy.http",
|
|
"mitmproxy.net.server_spec",
|
|
"mitmproxy.proxy.context",
|
|
"mitmproxy.proxy.mode_specs",
|
|
"mitmproxy.proxy.server_hooks",
|
|
"mitmproxy.tcp",
|
|
"mitmproxy.tls",
|
|
"mitmproxy.udp",
|
|
"mitmproxy.websocket",
|
|
here / ".." / "src" / "generated" / "events.py",
|
|
]
|
|
|
|
pdoc.pdoc(*modules, output_directory=here / ".." / "src" / "generated" / "api")
|
|
|
|
api_content = here / ".." / "src" / "content" / "api"
|
|
if api_content.exists():
|
|
shutil.rmtree(api_content)
|
|
|
|
api_content.mkdir()
|
|
|
|
for module in modules:
|
|
if isinstance(module, Path):
|
|
continue
|
|
filename = f"api/{module.replace('.', '/')}.html"
|
|
(api_content / f"{module}.md").write_bytes(
|
|
textwrap.dedent(
|
|
f"""
|
|
---
|
|
title: "{module}"
|
|
url: "{filename}"
|
|
|
|
menu: api
|
|
---
|
|
|
|
{{{{< readfile file="/generated/{filename}" >}}}}
|
|
"""
|
|
).encode()
|
|
)
|
|
|
|
(here / "../src/content/api/_index.md").write_text(
|
|
textwrap.dedent(
|
|
f"""\
|
|
---
|
|
title: "API Reference"
|
|
---
|
|
|
|
"""
|
|
),
|
|
newline="\n",
|
|
)
|