refactor doc

JE-Chen · JE-Chen · commit 7439443a81d9 · 2022-11-20T05:02:30.000+08:00
refactor doc
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/docs/source/Eng/doc/auto_control_critical_exit_doc/auto_control_critical_exit_doc.rst b/docs/source/Eng/doc/auto_control_critical_exit_doc/auto_control_critical_exit_doc.rst
@@ -1,4 +1,4 @@
-AutoControlGUI Critical Exit Doc
+AutoControl Critical Exit Doc
 ==========================
 
 .. code-block:: python
diff --git a/docs/source/Eng/doc/auto_control_executor_doc/auto_control_executor_doc.rst b/docs/source/Eng/doc/auto_control_executor_doc/auto_control_executor_doc.rst
@@ -1,4 +1,4 @@
-AutoControlGUI Executor Doc
+AutoControl Executor Doc
 ==========================
 
 .. code-block:: python
diff --git a/docs/source/Eng/doc/auto_control_file_process_doc/auto_control_file_process_doc.rst b/docs/source/Eng/doc/auto_control_file_process_doc/auto_control_file_process_doc.rst
@@ -1,4 +1,4 @@
-AutoControlGUI File Process Doc
+AutoControl File Process Doc
 ==========================
 
 
diff --git a/docs/source/Eng/doc/auto_control_image_doc/auto_control_image_doc.rst b/docs/source/Eng/doc/auto_control_image_doc/auto_control_image_doc.rst
@@ -1,4 +1,4 @@
-AutoControlGUI Image Doc
+AutoControl Image Doc
 ==========================
 
 .. code-block:: python
diff --git a/docs/source/Eng/doc/auto_control_keyboard_doc/auto_control_keyboard_doc.rst b/docs/source/Eng/doc/auto_control_keyboard_doc/auto_control_keyboard_doc.rst
@@ -1,4 +1,4 @@
-AutoControlGUI Keyboard Doc
+AutoControl Keyboard Doc
 ==========================
 
 
diff --git a/docs/source/Eng/doc/auto_control_mouse_doc/auto_control_mouse_doc.rst b/docs/source/Eng/doc/auto_control_mouse_doc/auto_control_mouse_doc.rst
@@ -1,4 +1,4 @@
-AutoControlGUI Mouse Doc
+AutoControl Mouse Doc
 ==========================
 
 
diff --git a/docs/source/Eng/doc/auto_control_record_doc/auto_control_record_doc.rst b/docs/source/Eng/doc/auto_control_record_doc/auto_control_record_doc.rst
@@ -1,4 +1,4 @@
-AutoControlGUI Record Doc
+AutoControl Record Doc
 ==========================
 
 
diff --git a/docs/source/Eng/doc/auto_control_screen_doc/auto_control_screen_doc.rst b/docs/source/Eng/doc/auto_control_screen_doc/auto_control_screen_doc.rst
@@ -1,4 +1,4 @@
-AutoControlGUI Screen Doc
+AutoControl Screen Doc
 ==========================
 
 
diff --git a/docs/source/Eng/doc/auto_control_test_record_doc/auto_control_test_record_doc.rst b/docs/source/Eng/doc/auto_control_test_record_doc/auto_control_test_record_doc.rst
@@ -1,4 +1,4 @@
-AutoControlGUI Test Record Doc
+AutoControl Test Record Doc
 ==========================
 
 
diff --git a/docs/source/Eng/doc/generate_html_doc/generate_html_doc.rst b/docs/source/Eng/doc/generate_html_doc/generate_html_doc.rst
@@ -1,6 +1,6 @@
-==========================
-AutoControlGUI Generate Html Report Doc
-==========================
+======================================
+AutoControl Generate Html Report Doc
+======================================
 
 
 .. code-block:: python
diff --git a/docs/source/Zh/doc/auto_control_critical_exit_doc/auto_control_critical_exit_doc.rst b/docs/source/Zh/doc/auto_control_critical_exit_doc/auto_control_critical_exit_doc.rst
@@ -1,32 +1,33 @@
-AutoControlGUI Critical Exit Doc
+AutoControl 緊急退出 文件
 ==========================
 
 .. code-block:: python
 
    class CriticalExit(Thread):
-    """
-    use to make program interrupt
-    """
+        "當程式需要緊急退出時可使用此類別"
 
         def __init__(self, default_daemon: bool = True):
             """
-            default interrupt is keyboard F7 key
+            預設使用鍵盤 F7 來緊急中斷
+            是否隨著主程式關閉監聽 預設 True
             :param default_daemon bool thread setDaemon
             """
 
         def set_critical_key(self, keycode: [int, str] = None):
             """
-            set interrupt key
+            設置中斷按鈕用
             :param keycode interrupt key
             """
 
           def run(self):
             """
+            本質上還是thread
             listener keycode _exit_check_key to interrupt
             """
 
          def init_critical_exit(self):
             """
+            應該使用這方法開始監聽而不是原始 thread start
             should only use this to start critical exit
             may this function will add more
             """
diff --git a/docs/source/Zh/doc/auto_control_executor_doc/auto_control_executor_doc.rst b/docs/source/Zh/doc/auto_control_executor_doc/auto_control_executor_doc.rst
@@ -1,16 +1,20 @@
-AutoControlGUI Executor Doc
+AutoControl 執行器 文件
 ==========================
 
 .. code-block:: python
 
     def execute_action(action_list: list):
         """
-        use to execute all action on action list(action file or python list)
+        執行所有在 list 裡的指令
         :param action_list the list include action
         for loop the list and execute action
         """
 
     """
+    執行範例 可以使用 指令檔(json) 或是程式給予資料方式
+    指令檔適合已經固定化的測試流程 (當然也可以用程式產生) 使用者取捨使用
+    指令檔格式如下所示 example_list (不同平台keycode不同，請注意)
+    程式格式也使用一樣的方式
     Executor example
     on program or action file
     use format like bottom
@@ -49,12 +53,14 @@ AutoControlGUI Executor Doc
 
     def read_action_json(json_file_path: str):
     """
+    讀取json指令檔用
     use to read action file
     :param json_file_path json file's path to read
     """
 
     def write_action_json(json_save_path: str, action_json: list):
     """
+    儲存json指令檔用
     use to save action file
     :param json_save_path  json save path
     :param action_json the json str include action to write
@@ -64,6 +70,7 @@ AutoControlGUI Executor Doc
 
     def execute_files(execute_files_list: list):
     """
+    執行所有在list裡的指令檔 循序讀取然後執行
     :param execute_files_list: list include execute files path
     :return: every execute detail as list
     """
diff --git a/docs/source/Zh/doc/auto_control_file_process_doc/auto_control_file_process_doc.rst b/docs/source/Zh/doc/auto_control_file_process_doc/auto_control_file_process_doc.rst
@@ -1,11 +1,13 @@
-AutoControlGUI File Process Doc
+AutoControl 檔案處理 文件
 ==========================
 
 
 .. code-block:: python
 
     def get_dir_files_as_list(dir_path: str = getcwd(), default_search_file_extension: str = ".json"):
     """
+    取得指定資料夾路徑下的 所有 default_search_file_extension 附檔名的檔案的 list
+    可以跟 執行器 模塊的 execute_files 一起使用
     get dir file when end with default_search_file_extension
     :param dir_path: which dir we want to walk and get file list
     :param default_search_file_extension: which extension we want to search
diff --git a/docs/source/Zh/doc/auto_control_image_doc/auto_control_image_doc.rst b/docs/source/Zh/doc/auto_control_image_doc/auto_control_image_doc.rst
@@ -1,26 +1,35 @@
-AutoControlGUI Image Doc
+AutoControl 圖片處理 文件
 ==========================
 
 .. code-block:: python
 
     def locate_all_image(image, detect_threshold: [float, int] = 1, draw_image: bool = False, **kwargs):
     """
-     use to locate all image that detected and then return detected images list
+    定位所有一樣的圖片 並回傳所有圖片的 list
+    use to locate all image that detected and then return detected images list
+    給予圖片路徑或者給予 PIL 的 ImageGrab.grab()
     :param image which image we want to find on screen (png or PIL ImageGrab.grab())
+    偵測辨別度 0.0 ~ 1.0 1.0 是絕對相同
     :param detect_threshold detect precision 0.0 ~ 1.0; 1 is absolute equal (float or int)
+    是否劃出偵測到圖片的範圍
     :param draw_image draw detect tag on return image (bool)
     """
 
     def locate_image_center(image, detect_threshold: [float, int] = 1, draw_image: bool = False, **kwargs):
     """
+    定位圖片並取得其中心點
     use to locate image and return image center position
+    給予圖片路徑或者給予 PIL 的 ImageGrab.grab()
     :param image which image we want to find on screen (png or PIL ImageGrab.grab())
+    偵測辨別度 0.0 ~ 1.0 1.0 是絕對相同
     :param detect_threshold detect precision 0.0 ~ 1.0; 1 is absolute equal (float or int)
+    是否劃出偵測到圖片的範圍
     :param draw_image draw detect tag on return image (bool)
     """
 
     def locate_and_click(image, mouse_keycode: [int, str], detect_threshold: [float, int] = 1, draw_image: bool = False, **kwargs):
     """
+    定位圖片並點擊其中心點
     use to locate image and click image center position and the return image center position
     :param image which image we want to find on screen (png or PIL ImageGrab.grab())
     :param mouse_keycode which mouse keycode we want to click
@@ -30,8 +39,11 @@ AutoControlGUI Image Doc
 
     def screenshot(file_path: str = None, region: list = None):
     """
+    截圖並存檔 可指定範圍
     use to get now screen image return image
+    存檔路徑
     :param file_path save screenshot path (None is no save)
+    截圖範圍
     :param region screenshot region (screenshot region on screen)
     """
 
diff --git a/docs/source/Zh/doc/auto_control_keyboard_doc/auto_control_keyboard_doc.rst b/docs/source/Zh/doc/auto_control_keyboard_doc/auto_control_keyboard_doc.rst
@@ -1,51 +1,69 @@
-AutoControlGUI Keyboard Doc
+AutoControl 鍵盤控制 文件
 ==========================
 
 
 .. code-block:: python
 
     def press_key(keycode: [int, str], is_shift: bool = False):
     """
+    按下鍵盤按鍵 keycode 或是 字串 回傳傳入的字串 傳入一個以上會引發錯誤
     use to press a key still press to use release key
     or use critical exit
     return keycode
+    哪個按鍵想按下
     :param keycode which keycode we want to press
+    是否按著 shift
     :param is_shift press shift True or False
     """
 
     def release_key(keycode: [int, str], is_shift: bool = False):
     """
+    放開鍵盤按鍵 keycode 或是 字串 回傳傳入的字串 傳入一個以上會引發錯誤
     use to release pressed key return keycode
+    哪個按鍵想放開
     :param keycode which keycode we want to release
+    是否按著 shift
     :param is_shift press shift True or False
     """
 
     def type_key(keycode: [int, str], is_shift: bool = False):
     """
+    按下跟放開鍵盤 (類似正常使用)
     press and release key return keycode
+    哪個按鍵想點擊
     :param keycode which keycode we want to type
+    是否按著 shift
     :param is_shift press shift True or False
     """
 
     def check_key_is_press(keycode: [int, str]):
     """
+    檢查鍵盤按鍵是否按下
     use to check key is press return True or False
+    要檢查的按鍵
     :param keycode check key is press or not
     """
 
     def write(write_string: str, is_shift: bool = False):
     """
+    對每個傳入的字元進行 type_key (按下與釋放的動作)
     use to press and release whole we get this function str
+    回傳有成功 type_key 的按鍵
     return all press and release str
+    字串來遍歷執行 type_key
     :param write_string while string not on write_string+1 type_key(string)
+    是否按著 shift
     :param is_shift press shift True or False
     """
 
     def hotkey(key_code_list: list, is_shift: bool = False):
     """
+    對傳入的按鍵進行 press_key 並反著釋放
     use to press and release all key on key_code_list
     then reverse list press and release again
+    回傳按下的 字串 以及釋放的字串
     return [press_str_list, release_str_list]
+    list 包含想按下與釋放的 按鍵
     :param key_code_list press and release all key on list and reverse
     :param is_shift press shift True or False
     """
diff --git a/docs/source/Zh/doc/auto_control_mouse_doc/auto_control_mouse_doc.rst b/docs/source/Zh/doc/auto_control_mouse_doc/auto_control_mouse_doc.rst
diff --git a/docs/source/Zh/doc/auto_control_record_doc/auto_control_record_doc.rst b/docs/source/Zh/doc/auto_control_record_doc/auto_control_record_doc.rst
diff --git a/docs/source/Zh/doc/auto_control_screen_doc/auto_control_screen_doc.rst b/docs/source/Zh/doc/auto_control_screen_doc/auto_control_screen_doc.rst
diff --git a/docs/source/Zh/doc/auto_control_test_record_doc/auto_control_test_record_doc.rst b/docs/source/Zh/doc/auto_control_test_record_doc/auto_control_test_record_doc.rst
diff --git a/docs/source/Zh/doc/generate_html_doc/generate_html_doc.rst b/docs/source/Zh/doc/generate_html_doc/generate_html_doc.rst

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-AutoControlGUI Critical Exit Doc`
	`1`	`+AutoControl Critical Exit Doc`
`2`	`2`	`==========================`
`3`	`3`
`4`	`4`	`.. code-block:: python`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-AutoControlGUI Executor Doc`
	`1`	`+AutoControl Executor Doc`
`2`	`2`	`==========================`
`3`	`3`
`4`	`4`	`.. code-block:: python`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-AutoControlGUI File Process Doc`
	`1`	`+AutoControl File Process Doc`
`2`	`2`	`==========================`
`3`	`3`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-AutoControlGUI Image Doc`
	`1`	`+AutoControl Image Doc`
`2`	`2`	`==========================`
`3`	`3`
`4`	`4`	`.. code-block:: python`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-AutoControlGUI Keyboard Doc`
	`1`	`+AutoControl Keyboard Doc`
`2`	`2`	`==========================`
`3`	`3`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-AutoControlGUI Mouse Doc`
	`1`	`+AutoControl Mouse Doc`
`2`	`2`	`==========================`
`3`	`3`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-AutoControlGUI Record Doc`
	`1`	`+AutoControl Record Doc`
`2`	`2`	`==========================`
`3`	`3`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-AutoControlGUI Screen Doc`
	`1`	`+AutoControl Screen Doc`
`2`	`2`	`==========================`
`3`	`3`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-AutoControlGUI Test Record Doc`
	`1`	`+AutoControl Test Record Doc`
`2`	`2`	`==========================`
`3`	`3`
`4`	`4`