Skip to content

Commit fddabf9

Browse files
committed
Add create project doc
Add create project doc
1 parent e7b3d25 commit fddabf9

File tree

6 files changed

+73
-24
lines changed

6 files changed

+73
-24
lines changed

Diff for: .idea/misc.xml

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: .idea/workspace.xml

+24-23
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Create Project
2+
----
3+
4+
In AutoControl, you can create a project which will automatically generate sample files once the project is created.
5+
These sample files include a Python executor file and a keyword.json file.
6+
7+
To create a project, you can use the following method:
8+
9+
.. code-block:: python
10+
11+
from je_auto_control import create_project_dir
12+
# create on current workdir
13+
create_project_dir()
14+
# create project on project_path
15+
create_project_dir("project_path")
16+
# create project on project_path and dir name is My First Project
17+
create_project_dir("project_path", "My First Project")
18+
19+
Or using CLI, this will generate a project at the project_path location.
20+
21+
.. code-block:: console
22+
23+
python -m je_auto_control --create_project project_path

Diff for: docs/source/Eng/eng_index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ AutoControl English Documentation
66
:maxdepth: 4
77

88
doc/installation/installation_doc.rst
9+
doc/create_project/create_project_doc.rst
910
doc/keyboard/keyboard_doc.rst
1011
doc/mouse/mouse_doc.rst
1112
doc/screen/screen_doc.rst
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
創建專案
2+
----
3+
4+
在 AutoControl 裡可以創建專案,創建專案後將會自動生成範例文件,
5+
範例文件包含 python executor 檔案以及 keyword.json 檔案。
6+
7+
要創建專案可以用以下方式:
8+
9+
.. code-block:: python
10+
11+
from je_auto_control import create_project_dir
12+
# create on current workdir
13+
create_project_dir()
14+
# create project on project_path
15+
create_project_dir("project_path")
16+
# create project on project_path and dir name is My First Project
17+
create_project_dir("project_path", "My First Project")
18+
19+
或是這個方式將會在 project_path 路徑產生專案
20+
21+
.. code-block:: console
22+
23+
python -m je_auto_control --create_project project_path

Diff for: docs/source/Zh/zh_index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ AutoControl 繁體中文 文件
66
:maxdepth: 4
77

88
doc/installation/installation_doc.rst
9+
doc/create_project/create_project_doc.rst
910
doc/keyboard/keyboard_doc.rst
1011
doc/mouse/mouse_doc.rst
1112
doc/screen/screen_doc.rst

0 commit comments

Comments
 (0)