2024-08-19 10:25:02 +08:00
|
|
|
|
<!doctype html>
|
|
|
|
|
|
<html lang="zh-CN" data-theme="light">
|
|
|
|
|
|
<head>
|
|
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
|
|
|
|
|
<meta name="generator" content="VuePress 2.0.0-rc.9" />
|
|
|
|
|
|
<meta name="theme" content="VuePress Theme Hope 2.0.0-rc.32" />
|
|
|
|
|
|
<style>
|
|
|
|
|
|
html {
|
|
|
|
|
|
background: var(--bg-color, #fff);
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
html[data-theme="dark"] {
|
|
|
|
|
|
background: var(--bg-color, #1d1e1f);
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
body {
|
|
|
|
|
|
background: var(--bg-color);
|
|
|
|
|
|
}
|
|
|
|
|
|
</style>
|
|
|
|
|
|
<script>
|
|
|
|
|
|
const userMode = localStorage.getItem("vuepress-theme-hope-scheme");
|
|
|
|
|
|
const systemDarkMode =
|
|
|
|
|
|
window.matchMedia &&
|
|
|
|
|
|
window.matchMedia("(prefers-color-scheme: dark)").matches;
|
|
|
|
|
|
|
|
|
|
|
|
if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) {
|
|
|
|
|
|
document.documentElement.setAttribute("data-theme", "dark");
|
|
|
|
|
|
}
|
|
|
|
|
|
</script>
|
2024-08-19 23:51:06 +08:00
|
|
|
|
<link rel="alternate" hreflang="en-us" href="https://vuepress-theme-hope-docs-demo.netlify.app/en/dev/api/mkdoc.html"><meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/dev/api/mkdoc.html"><meta property="og:site_name" content="LiteyukiBot 轻雪机器人"><meta property="og:title" content="liteyuki.mkdoc"><meta property="og:description" content="def get_relative_path(base_path: str, target_path: str) -> str 获取相对路径 Args: def write_to_files(file_data: dict[str, str]) -> None 输出文件 Args: def get_file_list(module_folder: str..."><meta property="og:type" content="article"><meta property="og:locale" content="zh-CN"><meta property="og:locale:alternate" content="en-US"><meta property="og:updated_time" content="2024-08-19T02:24:13.000Z"><meta property="article:modified_time" content="2024-08-19T02:24:13.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"liteyuki.mkdoc","image":[""],"dateModified":"2024-08-19T02:24:13.000Z","author":[]}</script><script src="/js/zh/get_data.js" type="module"></script><script src="/js/style.js" type="module"></script><link rel="icon" href="https://cdn.liteyuki.icu/favicon.ico"><link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/firacode/6.2.0/fira_code.min.css"><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"><title>liteyuki.mkdoc | LiteyukiBot 轻雪机器人</title><meta name="description" content="def get_relative_path(base_path: str, target_path: str) -> str 获取相对路径 Args: def write_to_files(file_data: dict[str, str]) -> None 输出文件 Args: def get_file_list(module_folder: str...">
|
2024-08-19 10:25:02 +08:00
|
|
|
|
<link rel="preload" href="/assets/style-CSEr-Ojo.css" as="style"><link rel="stylesheet" href="/assets/style-CSEr-Ojo.css">
|
2024-08-20 20:39:11 +08:00
|
|
|
|
<link rel="modulepreload" href="/assets/app-Bs1PeMf0.js"><link rel="modulepreload" href="/assets/mkdoc.html-DvuxL8et.js">
|
|
|
|
|
|
<link rel="prefetch" href="/assets/index.html-CXXO6xcH.js" as="script"><link rel="prefetch" href="/assets/index.html-DrSFzvRf.js" as="script"><link rel="prefetch" href="/assets/config.html-jXXfcHdL.js" as="script"><link rel="prefetch" href="/assets/fandq.html-CZwFx6EP.js" as="script"><link rel="prefetch" href="/assets/install.html-Byj8VUg-.js" as="script"><link rel="prefetch" href="/assets/index.html-ljg_PI1R.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-DH1VjFpJ.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-RUDtzk1B.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-Dzb4NNEu.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-CT4UraRi.js" as="script"><link rel="prefetch" href="/assets/index.html-BG-OTJ01.js" as="script"><link rel="prefetch" href="/assets/index.html-DayvyYmV.js" as="script"><link rel="prefetch" href="/assets/plugin.html-DYl5C-yG.js" as="script"><link rel="prefetch" href="/assets/resource.html-w4v4-ls4.js" as="script"><link rel="prefetch" href="/assets/index.html-C-5_z4Ql.js" as="script"><link rel="prefetch" href="/assets/agreement.html-DTrW--oO.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-CLFR4-SL.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-ByptD_MK.js" as="script"><link rel="prefetch" href="/assets/index.html-X4AQiuCY.js" as="script"><link rel="prefetch" href="/assets/config.html-x2DggEEz.js" as="script"><link rel="prefetch" href="/assets/exception.html-BnPs2xtp.js" as="script"><link rel="prefetch" href="/assets/log.html-B6ne9LQi.js" as="script"><link rel="prefetch" href="/assets/utils.html-DIGgwcLa.js" as="script"><link rel="prefetch" href="/assets/index.html-DSmJ2m9V.js" as="script"><link rel="prefetch" href="/assets/config.html-JHrVObO1.js" as="script"><link rel="prefetch" href="/assets/fandq.html-DwSlEl9h.js" as="script"><link rel="prefetch" href="/assets/install.html-T5JrtwZR.js" as="script"><link rel="prefetch" href="/assets/index.html-CcKUYTsl.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-Dffo7Ipz.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-C1z3XK3f.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-CwQDqgqg.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-hzjN8h_W.js" as="script"><link rel="prefetch" href="/assets/index.html-CydeTHZa.js" as="script"><link rel="prefetch" href="/assets/plugin.html-OrnCCBoS.js" as="script"><link rel="prefetch" href="/assets/resource.html-B-5sMHx4.js" as="script"><link rel="prefetch" href="/assets/index.html-jXobCw6I.js" as="script"><link rel="prefetch" href="/assets/agreement.html-DgwwyIXl.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-Djt1jsoL.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-CqZWearh.js" as="script"><link rel="prefetch" href="/assets/index.html-BNS6aWZs.js" as="script"><link rel="prefetch" href="/assets/lifespan.html-BThnlarw.js" as="script"><link rel="prefetch" href="/assets/index.html-D9A3PrLB.js" as="script"><link rel="prefetch" href="/assets/channel.html-CJlHQUyq.js" as="script"><link rel="prefetch" href="/assets/event.html-CYw2tPLX.js" as="script"><link rel="prefetch" href="/assets/storage.html-C3Od2hbX.js" as="script"><link rel="prefetch" href="/assets/index.html-Bom3tjBi.js" as="script"><link rel="prefetch" href="/assets/manager.html-BV5ldr2L.js" as="script"><link rel="prefetch" href="/assets/index.html-LtkmrGu9.js" as="script"><link rel="prefetch" href="/assets/observer.html-C7rFMFl-.js" as="script"><link rel="prefetch" href="/assets/plugin.html-BBrieOL3.js" as="script"><link rel="prefetch" href="/assets/index.html-JDKOSGWq.js" as="script"><link rel="prefetch" href="/assets/event.html-ChvlMQKp.js" as="script"><link rel="prefetch" href="/assets/matcher.html-BlyTwki1.js" as="script"><link rel="prefetch" href="/assets/on.html-BsRFg2Z3.js" as="script"><link rel="prefetch" href="/assets/rule.html-zZdLdX_D.js" as="script"><link rel="prefetch" href="/assets/session.html-c_Rhlapx.js" as=
|
2024-08-19 10:25:02 +08:00
|
|
|
|
</head>
|
|
|
|
|
|
<body>
|
2024-08-19 23:51:06 +08:00
|
|
|
|
<div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">跳至主要內容</a><!--]--><div class="theme-container has-toc"><!--[--><header id="navbar" class="vp-navbar"><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><!----><!--]--><!--[--><a class="route-link vp-brand" href="/"><img class="vp-nav-logo" src="https://cdn.liteyuki.icu/static/img/liteyuki_icon_640.png" alt><!----><span class="vp-site-name hide-in-pad">LiteyukiBot 轻雪机器人</span></a><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-center"><!--[--><!----><!--]--><!--[--><nav class="vp-nav-links"><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/" aria-label="首页"><span class="font-icon icon fa-fw fa-sm fas fa-home" style=""></span>首页<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/deploy/" aria-label="安装及部署"><!---->安装及部署<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/usage/" aria-label="使用及功能"><!---->使用及功能<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/store/" aria-label="资源及插件"><!---->资源及插件<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link active" href="/dev/" aria-label="开发及贡献"><!---->开发及贡献<!----></a></div></nav><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-end"><!--[--><!----><!--]--><!--[--><div class="nav-item"><div class="dropdown-wrapper i18n-dropdown"><button type="button" class="dropdown-title" aria-label="选择语言"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a class="route-link nav-link active" href="/dev/api/mkdoc.html" aria-label="简体中文"><!---->简体中文<!----></a></li><li class="dropdown-item"><a class="route-link nav-link" href="/en/dev/api/mkdoc.html" aria-label="English"><!---->English<!----></a></li></ul></button></div></div><div class="nav-item vp-repo"><a class="vp-repo-link" href="https://github.com/LiteyukiStudio/LiteyukiBot" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 2
|
2024-08-19 10:25:02 +08:00
|
|
|
|
|
|
|
|
|
|
target_path: 目标路径
|
|
|
|
|
|
</code></pre><h3 id="def-write-to-files-file-data-dict-str-str-none" tabindex="-1"><a class="header-anchor" href="#def-write-to-files-file-data-dict-str-str-none"><span><em><strong>def</strong></em> <code>write_to_files(file_data: dict[str, str]) -> None</code></span></a></h3><p>输出文件</p><p>Args:</p><pre><code>file_data: 文件数据 相对路径
|
|
|
|
|
|
</code></pre><h3 id="def-get-file-list-module-folder-str-none" tabindex="-1"><a class="header-anchor" href="#def-get-file-list-module-folder-str-none"><span><em><strong>def</strong></em> <code>get_file_list(module_folder: str) -> None</code></span></a></h3><h3 id="def-get-module-info-normal-file-path-str-ignore-private-bool-moduleinfo" tabindex="-1"><a class="header-anchor" href="#def-get-module-info-normal-file-path-str-ignore-private-bool-moduleinfo"><span><em><strong>def</strong></em> <code>get_module_info_normal(file_path: str, ignore_private: bool) -> ModuleInfo</code></span></a></h3><p>获取函数和类</p><p>Args:</p><pre><code>file_path: Python 文件路径
|
|
|
|
|
|
|
|
|
|
|
|
ignore_private: 忽略私有函数和类
|
|
|
|
|
|
</code></pre><p>Returns:</p><pre><code>模块信息
|
|
|
|
|
|
</code></pre><h3 id="def-generate-markdown-module-info-moduleinfo-front-matter-any-str" tabindex="-1"><a class="header-anchor" href="#def-generate-markdown-module-info-moduleinfo-front-matter-any-str"><span><em><strong>def</strong></em> <code>generate_markdown(module_info: ModuleInfo, front_matter: Any) -> str</code></span></a></h3><p>生成模块的Markdown</p><p>你可在此自定义生成的Markdown格式</p><p>Args:</p><pre><code>module_info: 模块信息
|
|
|
|
|
|
|
|
|
|
|
|
front_matter: 自定义选项title, index, icon, category
|
|
|
|
|
|
</code></pre><p>Returns:</p><pre><code>Markdown 字符串
|
|
|
|
|
|
</code></pre><h3 id="def-generate-docs-module-folder-str-output-dir-str-with-top-bool-ignored-paths-any-none" tabindex="-1"><a class="header-anchor" href="#def-generate-docs-module-folder-str-output-dir-str-with-top-bool-ignored-paths-any-none"><span><em><strong>def</strong></em> <code>generate_docs(module_folder: str, output_dir: str, with_top: bool, ignored_paths: Any) -> None</code></span></a></h3><p>生成文档</p><p>Args:</p><pre><code>module_folder: 模块文件夹
|
|
|
|
|
|
|
|
|
|
|
|
output_dir: 输出文件夹
|
|
|
|
|
|
|
|
|
|
|
|
with_top: 是否包含顶层文件夹 False时例如docs/api/module_a, docs/api/module_b， True时例如docs/api/module/module_a.md， docs/api/module/module_b.md
|
|
|
|
|
|
|
|
|
|
|
|
ignored_paths: 忽略的路径
|
2024-08-19 23:51:06 +08:00
|
|
|
|
</code></pre><h3 id="class-deftype-enum" tabindex="-1"><a class="header-anchor" href="#class-deftype-enum"><span><em><strong>class</strong></em> <code>DefType(Enum)</code></span></a></h3><h3 id="attr-function-function" tabindex="-1"><a class="header-anchor" href="#attr-function-function"><span> <em><strong>attr</strong></em> <code>FUNCTION: 'function'</code></span></a></h3><h3 id="attr-method-method" tabindex="-1"><a class="header-anchor" href="#attr-method-method"><span> <em><strong>attr</strong></em> <code>METHOD: 'method'</code></span></a></h3><h3 id="attr-static-method-staticmethod" tabindex="-1"><a class="header-anchor" href="#attr-static-method-staticmethod"><span> <em><strong>attr</strong></em> <code>STATIC_METHOD: 'staticmethod'</code></span></a></h3><h3 id="attr-class-method-classmethod" tabindex="-1"><a class="header-anchor" href="#attr-class-method-classmethod"><span> <em><strong>attr</strong></em> <code>CLASS_METHOD: 'classmethod'</code></span></a></h3><h3 id="attr-property-property" tabindex="-1"><a class="header-anchor" href="#attr-property-property"><span> <em><strong>attr</strong></em> <code>PROPERTY: 'property'</code></span></a></h3><h3 id="class-functioninfo-basemodel" tabindex="-1"><a class="header-anchor" href="#class-functioninfo-basemodel"><span><em><strong>class</strong></em> <code>FunctionInfo(BaseModel)</code></span></a></h3><h3 id="class-attributeinfo-basemodel" tabindex="-1"><a class="header-anchor" href="#class-attributeinfo-basemodel"><span><em><strong>class</strong></em> <code>AttributeInfo(BaseModel)</code></span></a></h3><h3 id="class-classinfo-basemodel" tabindex="-1"><a class="header-anchor" href="#class-classinfo-basemodel"><span><em><strong>class</strong></em> <code>ClassInfo(BaseModel)</code></span></a></h3><h3 id="class-moduleinfo-basemodel" tabindex="-1"><a class="header-anchor" href="#class-moduleinfo-basemodel"><span><em><strong>class</strong></em> <code>ModuleInfo(BaseModel)</code></span></a></h3><h3 id="var-no-type-any-any" tabindex="-1"><a class="header-anchor" href="#var-no-type-any-any"><span><em><strong>var</strong></em> <code>NO_TYPE_ANY = 'Any'</code></span></a></h3><h3 id="var-no-type-hint-notypehint" tabindex="-1"><a class="header-anchor" href="#var-no-type-hint-notypehint"><span><em><strong>var</strong></em> <code>NO_TYPE_HINT = 'NoTypeHint'</code></span></a></h3><h3 id="var-function-function" tabindex="-1"><a class="header-anchor" href="#var-function-function"><span><em><strong>var</strong></em> <code>FUNCTION = 'function'</code></span></a></h3><h3 id="var-method-method" tabindex="-1"><a class="header-anchor" href="#var-method-method"><span><em><strong>var</strong></em> <code>METHOD = 'method'</code></span></a></h3><h3 id="var-static-method-staticmethod" tabindex="-1"><a class="header-anchor" href="#var-static-method-staticmethod"><span><em><strong>var</strong></em> <code>STATIC_METHOD = 'staticmethod'</code></span></a></h3><h3 id="var-class-method-classmethod" tabindex="-1"><a class="header-anchor" href="#var-class-method-classmethod"><span><em><strong>var</strong></em> <code>CLASS_METHOD = 'classmethod'</code></span></a></h3><h3 id="var-property-property" tabindex="-1"><a class="header-anchor" href="#var-property-property"><span><em><strong>var</strong></em> <code>PROPERTY = 'property'</code></span></a></h3><h3 id="var-file-list" tabindex="-1"><a class="header-anchor" href="#var-file-list"><span><em><strong>var</strong></em> <code>file_list = []</code></span></a></h3><h3 id="var-dot-sep-module-path-file-path-replace-os-sep-replace-py-replace-pyi" tabindex="-1"><a class="header-anchor" href="#var-dot-sep-module-path-file-path-replace-os-sep-replace-py-replace-pyi"><span><em><strong>var</strong></em> <code>dot_sep_module_path = file_path.replace(os.sep, '.').replace('.py', '').replace('.pyi', '')</code></span></a></h3><h3 id="var-module-docstring-ast-get-docstring-tree" tabindex="-1"><a class="header-anchor" href="#var-
|
2024-08-20 20:39:11 +08:00
|
|
|
|
<script type="module" src="/assets/app-Bs1PeMf0.js" defer></script>
|
2024-08-19 10:25:02 +08:00
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
