Skip to content

Commit c4d3ff3

Browse files
JE-ChenJE-Chen
committed
Add Sphinx automodule entries for recent core/local/remote/server modules
Covers the modules added in the previous feature series that weren't wired into the API docs yet: rate_limit, circuit_breaker, file_lock, sqlite_lock, action_queue, content_store, progress, archive_ops, diff_ops, mime, templates, trash, versioning, webdav, smb, fsspec_bridge, web_ui, mcp_server, network_guards. Mirrored to zh-TW and zh-CN trees.
1 parent 1bf442e commit c4d3ff3

12 files changed

Lines changed: 245 additions & 0 deletions

File tree

‎docs/source.zh-CN/api/core.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,27 @@ Core
2525
.. automodule:: automation_file.core.quota
2626
:members:
2727

28+
.. automodule:: automation_file.core.rate_limit
29+
:members:
30+
31+
.. automodule:: automation_file.core.circuit_breaker
32+
:members:
33+
34+
.. automodule:: automation_file.core.file_lock
35+
:members:
36+
37+
.. automodule:: automation_file.core.sqlite_lock
38+
:members:
39+
40+
.. automodule:: automation_file.core.action_queue
41+
:members:
42+
43+
.. automodule:: automation_file.core.content_store
44+
:members:
45+
46+
.. automodule:: automation_file.core.progress
47+
:members:
48+
2849
.. automodule:: automation_file.core.checksum
2950
:members:
3051

‎docs/source.zh-CN/api/local.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,21 @@
2727

2828
.. automodule:: automation_file.local.conditional
2929
:members:
30+
31+
.. automodule:: automation_file.local.archive_ops
32+
:members:
33+
34+
.. automodule:: automation_file.local.diff_ops
35+
:members:
36+
37+
.. automodule:: automation_file.local.mime
38+
:members:
39+
40+
.. automodule:: automation_file.local.templates
41+
:members:
42+
43+
.. automodule:: automation_file.local.trash
44+
:members:
45+
46+
.. automodule:: automation_file.local.versioning
47+
:members:

‎docs/source.zh-CN/api/remote.rst‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,34 @@ FTP / FTPS
138138
.. automodule:: automation_file.remote.ftp.list_ops
139139
:members:
140140

141+
WebDAV
142+
------
143+
144+
以 HTTP 为基础的远程存储客户端。使用 PROPFIND 获取目录列表；除非显式传入
145+
``allow_private_hosts=True``，否则拒绝连往私有 / loopback 目标。
146+
147+
.. automodule:: automation_file.remote.webdav.client
148+
:members:
149+
150+
SMB / CIFS
151+
----------
152+
153+
基于 ``smbprotocol`` 包的高阶 :mod:`smbclient` API。底层采用 UNC 路径
154+
（``\\\\server\\share\\path``），默认启用加密会话。
155+
156+
.. automodule:: automation_file.remote.smb.client
157+
:members:
158+
159+
fsspec 桥接
160+
-----------
161+
162+
对 `fsspec <https://filesystem-spec.readthedocs.io/>`_ 的薄包装层，使其
163+
支持的任意文件系统（memory、local、s3、gcs、abfs、…）都能通过动作注册表
164+
驱动。未提供 SSRF 防护——仅作为开发辅助工具，请勿当作远程接入面暴露。
165+
166+
.. automodule:: automation_file.remote.fsspec_bridge
167+
:members:
168+
141169
跨后端
142170
------
143171

‎docs/source.zh-CN/api/server.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,22 @@
77
.. automodule:: automation_file.server.http_server
88
:members:
99

10+
HTTP 服务器还提供 ``GET /healthz``（liveness）、``GET /readyz``
11+
（readiness——注册表为空时返回 503）、``GET /openapi.json``（OpenAPI 3.0
12+
规格），以及 ``GET /progress``（通过 WebSocket 推送
13+
:class:`automation_file.core.progress.progress_registry` 快照）。
14+
15+
.. automodule:: automation_file.server.web_ui
16+
:members:
17+
18+
.. automodule:: automation_file.server.mcp_server
19+
:members:
20+
1021
.. automodule:: automation_file.server.metrics_server
1122
:members:
1223
1324
.. automodule:: automation_file.server.action_acl
1425
:members:
26+
27+
.. automodule:: automation_file.server.network_guards
28+
:members:

‎docs/source.zh-TW/api/core.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,27 @@ Core
2525
.. automodule:: automation_file.core.quota
2626
:members:
2727

28+
.. automodule:: automation_file.core.rate_limit
29+
:members:
30+
31+
.. automodule:: automation_file.core.circuit_breaker
32+
:members:
33+
34+
.. automodule:: automation_file.core.file_lock
35+
:members:
36+
37+
.. automodule:: automation_file.core.sqlite_lock
38+
:members:
39+
40+
.. automodule:: automation_file.core.action_queue
41+
:members:
42+
43+
.. automodule:: automation_file.core.content_store
44+
:members:
45+
46+
.. automodule:: automation_file.core.progress
47+
:members:
48+
2849
.. automodule:: automation_file.core.checksum
2950
:members:
3051

‎docs/source.zh-TW/api/local.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,21 @@
2727

2828
.. automodule:: automation_file.local.conditional
2929
:members:
30+
31+
.. automodule:: automation_file.local.archive_ops
32+
:members:
33+
34+
.. automodule:: automation_file.local.diff_ops
35+
:members:
36+
37+
.. automodule:: automation_file.local.mime
38+
:members:
39+
40+
.. automodule:: automation_file.local.templates
41+
:members:
42+
43+
.. automodule:: automation_file.local.trash
44+
:members:
45+
46+
.. automodule:: automation_file.local.versioning
47+
:members:

‎docs/source.zh-TW/api/remote.rst‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,34 @@ FTP / FTPS
138138
.. automodule:: automation_file.remote.ftp.list_ops
139139
:members:
140140

141+
WebDAV
142+
------
143+
144+
以 HTTP 為基礎的遠端儲存客戶端。使用 PROPFIND 取得目錄列表；除非明確傳入
145+
``allow_private_hosts=True``，否則拒絕連往私有 / loopback 目標。
146+
147+
.. automodule:: automation_file.remote.webdav.client
148+
:members:
149+
150+
SMB / CIFS
151+
----------
152+
153+
建構於 ``smbprotocol`` 套件的高階 :mod:`smbclient` API 之上。底層採用 UNC
154+
路徑（``\\\\server\\share\\path``），預設啟用加密連線。
155+
156+
.. automodule:: automation_file.remote.smb.client
157+
:members:
158+
159+
fsspec 橋接
160+
-----------
161+
162+
以 `fsspec <https://filesystem-spec.readthedocs.io/>`_ 為基礎的薄包裝層，
163+
讓其支援的任何檔案系統（memory、local、s3、gcs、abfs、…）皆可透過動作
164+
登錄表驅動。未提供 SSRF 防護——僅建議作為開發輔助工具，切勿當作遠端接入介面。
165+
166+
.. automodule:: automation_file.remote.fsspec_bridge
167+
:members:
168+
141169
跨後端
142170
------
143171

‎docs/source.zh-TW/api/server.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,22 @@
77
.. automodule:: automation_file.server.http_server
88
:members:
99

10+
HTTP 伺服器另外提供 ``GET /healthz``（liveness）、``GET /readyz``
11+
（readiness——登錄表為空時回傳 503）、``GET /openapi.json``（OpenAPI 3.0
12+
規格），以及 ``GET /progress``（以 WebSocket 推送
13+
:class:`automation_file.core.progress.progress_registry` 快照）。
14+
15+
.. automodule:: automation_file.server.web_ui
16+
:members:
17+
18+
.. automodule:: automation_file.server.mcp_server
19+
:members:
20+
1021
.. automodule:: automation_file.server.metrics_server
1122
:members:
1223
1324
.. automodule:: automation_file.server.action_acl
1425
:members:
26+
27+
.. automodule:: automation_file.server.network_guards
28+
:members:

‎docs/source/api/core.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,27 @@ Core
2525
.. automodule:: automation_file.core.quota
2626
:members:
2727

28+
.. automodule:: automation_file.core.rate_limit
29+
:members:
30+
31+
.. automodule:: automation_file.core.circuit_breaker
32+
:members:
33+
34+
.. automodule:: automation_file.core.file_lock
35+
:members:
36+
37+
.. automodule:: automation_file.core.sqlite_lock
38+
:members:
39+
40+
.. automodule:: automation_file.core.action_queue
41+
:members:
42+
43+
.. automodule:: automation_file.core.content_store
44+
:members:
45+
46+
.. automodule:: automation_file.core.progress
47+
:members:
48+
2849
.. automodule:: automation_file.core.checksum
2950
:members:
3051

‎docs/source/api/local.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,21 @@ Local operations
2727

2828
.. automodule:: automation_file.local.conditional
2929
:members:
30+
31+
.. automodule:: automation_file.local.archive_ops
32+
:members:
33+
34+
.. automodule:: automation_file.local.diff_ops
35+
:members:
36+
37+
.. automodule:: automation_file.local.mime
38+
:members:
39+
40+
.. automodule:: automation_file.local.templates
41+
:members:
42+
43+
.. automodule:: automation_file.local.trash
44+
:members:
45+
46+
.. automodule:: automation_file.local.versioning
47+
:members:

0 commit comments

Comments
 (0)