📝 自举生成文档（bushi）

LiteyukiStudio · Aug 29, 2024 · c0417fd · c0417fd
1 parent 89afbcf
commit c0417fd
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 90 deletions.
diff --git a/docs/api/i18n.md b/docs/api/i18n.md
@@ -7,37 +7,10 @@ title: litedoc.i18n
 
 **Description**: Flatten i18n_dict.
 
-**Examples**:
-  - ```python
->        **docs.input**: 
->        **docs.output**: 
-  - {
->        **docs.input**: 
->        **docs.output**: 
-  - "en"
->        **docs.input**: {
->        **docs.output**: 
-  - "docs"
->        **docs.input**: {
->        **docs.output**: 
-  - "key1"
->        **docs.input**: "val1",
->        **docs.output**: 
-  - "key2"
->        **docs.input**: "val2",
->        **docs.output**: 
-  - }
->        **docs.input**: 
->        **docs.output**: 
-  - }
->        **docs.input**: 
->        **docs.output**: 
-  - }
->        **docs.input**: 
->        **docs.output**: 
-  - ```
->        **docs.input**: 
->        **docs.output**: 
+**Arguments**:
+> - data: i18n_dict  
+
+**Return**: dict: flatten dict
 
 
 <details>
@@ -47,29 +20,10 @@ title: litedoc.i18n
 def flat_i18n_dict(data: dict[str, NestedDict]) -> dict[str, dict[str, str]]:
     """
     Flatten i18n_dict.
-    Examples:
-        ```python
-        {
-            "en": {
-                "docs": {
-                    "key1": "val1",
-                    "key2": "val2",
-                }
-            }
-        }
-        ```
-
-        to
-
-        ```python
-        {
-            "en": {
-                "docs.key1": "val1",
-                "docs.key2": "val2",
-            }
-        }
-        ```
+    Args:
+        data: i18n_dict
     Returns:
+        dict: flatten dict
     """
     ret: dict[str, dict[str, str]] = {}
 

diff --git a/docs/api/style/markdown.md b/docs/api/style/markdown.md
@@ -53,6 +53,7 @@ def generate(parser: AstParser, lang: str, frontmatter: Optional[dict]=None, sty
     '遍历变量'
     for var in parser.variables:
         if var.docs is not None and litedoc_hide not in var.docs:
+            print(var.docs)
             md += f'### ***var*** `{var.name} = {var.value}`\n\n'
             if var.type != TypeHint.NO_TYPEHINT:
                 md += f"- **{get_text(lang, 'type')}**: `{var.type}`\n\n"

diff --git a/litedoc/i18n.py b/litedoc/i18n.py
@@ -6,7 +6,8 @@
 
 NestedDict: TypeAlias = dict[str, 'str | NestedDict']
 
-i18n_dict: dict[str, NestedDict] = {
+"""@litedoc-hide"""
+i18n_dict: dict[str, NestedDict] = {  # @litedoc-hide
         "en"     : {
                 "docstring": {
                         "args"     : "Arguments",
@@ -16,9 +17,9 @@
                         "example"  : "Examples",
                         "yields"   : "Yields",
                 },
-                "src": "Source code",
-                "desc": "Description",
-                "type": "Type",
+                "src"      : "Source code",
+                "desc"     : "Description",
+                "type"     : "Type",
         },
         "zh-Hans": {
                 "docstring": {
@@ -29,9 +30,9 @@
                         "example"  : "示例",
                         "yields"   : "产出",
                 },
-                "src": "源代码",
-                "desc": "说明",
-                "type": "类型",
+                "src"      : "源代码",
+                "desc"     : "说明",
+                "type"     : "类型",
         },
         "zh-Hant": {
                 "docstring": {
@@ -42,9 +43,9 @@
                         "example"  : "範例",
                         "yields"   : "產出",
                 },
-                "src": "源碼",
-                "desc": "説明",
-                "type": "類型",
+                "src"      : "源碼",
+                "desc"     : "説明",
+                "type"     : "類型",
         },
         "ja"     : {
                 "docstring": {
@@ -55,40 +56,20 @@
                         "example"  : "例",
                         "yields"   : "生成",
                 },
-                "src": "ソースコード",
-                "desc": "説明",
-                "type": "タイプ",
+                "src"      : "ソースコード",
+                "desc"     : "説明",
+                "type"     : "タイプ",
         },
-}
-"""@litedoc-hide"""
+}  # @litedoc-hide
 
 
 def flat_i18n_dict(data: dict[str, NestedDict]) -> dict[str, dict[str, str]]:
     """
     Flatten i18n_dict.
-    Examples:
-        ```python
-        {
-            "en": {
-                "docs": {
-                    "key1": "val1",
-                    "key2": "val2",
-                }
-            }
-        }
-        ```
-
-        to
-
-        ```python
-        {
-            "en": {
-                "docs.key1": "val1",
-                "docs.key2": "val2",
-            }
-        }
-        ```
+    Args:
+        data: i18n_dict
     Returns:
+        dict: flatten dict
     """
     ret: dict[str, dict[str, str]] = {}