Skip to content

Commit 64ecad5

Browse files
committed
update document
1 parent 2847313 commit 64ecad5

File tree

4 files changed

+12
-8
lines changed

4 files changed

+12
-8
lines changed

docs/en/docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ CONTENT=../mycomics/ thumb=/tmp/thumb/ display_title_format='{subtitle}\n{title}
133133
```
134134
or
135135
``` bash
136-
importEHdb_matchtorrent=False importEHdb_matchtitle=False CONTENT=../mycomics/ thumb=/tmp/thumb/ display_title_format='{subtitle}\n{title}\n{path}' uvicorn comiclib.main:app --uds /tmp/comiclib.sock --reload --log-level trace
136+
CONTENT=../mycomics/ thumb=/tmp/thumb/ display_title_format='{subtitle}\n{title}\n{path}' uvicorn comiclib.main:app --uds /tmp/comiclib.sock --reload --log-level trace
137137
```
138138
for debugging.
139139
Then use Nginx to reverse proxy to HTTPS connection.

docs/en/docs/scan&watch.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Scanning can be triggered in the following four ways:
77
* When starting ComicLib, perform a full scan
88
* After ComicLib is started, if `watch=True`, creation/modification events (only files) are monitored in the directory indicated by the `content` environment variable.
99
* Manually run the `comicscan` command for a full scan
10-
* Call the `scan` interface to scan a single file/folder, e.g.:
10+
* Call the `scan` interface to scan a specific file/folder, e.g.:
1111

1212
``` python
1313
from comiclib.scan import scan
14-
scan("content/comic/to/scan") # The path should be a subpath to the directory indicated by the `content` environment variable
14+
scan(["content/comic/to/scan"]) # The path should be a subpath to the directory indicated by the `content` environment variable
1515
# For folders, this means trying to treat the folder itself as a comic rather than searching for multiple comics in it
1616
```
1717

@@ -22,4 +22,6 @@ Use the same environment variables when executing the above command. If the sett
2222
* All files/folders in the directory indicated by the `content` environment variable are candidates for comics
2323
* Relative paths are an important identifier of comics. This means that if a comic is moved elsewhere, ComicLib will think it is another comic; comics with the same path will be skipped when rescanning, unless `skip_exists=False`; move the entire comic library elsewhere and modify the `content` environment variable to keep the relative relationship unchanged will not need a rescanning.
2424
* The main part of ComicLib is only responsible for traversing the comic library. The judgment of comic files are completed through scanners.
25-
* [Scanner script](scanner.md) is also responsible for metadata analysis and thumbnail extraction of comics.
25+
* [Scanner](scanner.md) is also responsible for metadata analysis and thumbnail extraction of comics.
26+
* During a complete scan, if an error occurs in the [scanner](scanner.md), the entire scan will be stopped to allow the user to determine the error, but the scan progress will be retained.
27+
* Errors encountered during monitoring will be ignored.

docs/zh/docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ CONTENT=../mycomics/ thumb=/tmp/thumb/ display_title_format='{subtitle}\n{title}
134134
```
135135
或者
136136
``` bash
137-
importEHdb_matchtorrent=False importEHdb_matchtitle=False CONTENT=../mycomics/ thumb=/tmp/thumb/ display_title_format='{subtitle}\n{title}\n{path}' uvicorn comiclib.main:app --uds /tmp/comiclib.sock --reload --log-level trace
137+
CONTENT=../mycomics/ thumb=/tmp/thumb/ display_title_format='{subtitle}\n{title}\n{path}' uvicorn comiclib.main:app --uds /tmp/comiclib.sock --reload --log-level trace
138138
```
139139
用于调试。
140140
然后通过 Nginx 反代为 HTTPS 连接。

docs/zh/docs/scan&watch.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
* 启动 ComicLib 时,进行一次完整扫描
88
* ComicLib 启动后,当 `watch=True` 时,监视到 `content` 环境变量指示的目录下发生创建/修改事件(仅限于文件)
99
* 手动运行 `comicscan` 命令进行完整扫描
10-
* 调用 `scan` 接口进行单一文件/文件夹扫描,如:
10+
* 调用 `scan` 接口扫描特定的文件/文件夹,如:
1111

1212
``` python
1313
from comiclib.scan import scan
14-
scan("content/comic/to/scan") # 路径应为 `content` 环境变量指示的目录的子路径
14+
scan(["content/comic/to/scan"]) # 路径应为 `content` 环境变量指示的目录的子路径
1515
# 对于文件夹,这意味着尝试将该文件夹本身作为一个漫画,而不是搜寻其下的多个漫画
1616
```
1717

@@ -22,4 +22,6 @@ scan("content/comic/to/scan") # 路径应为 `content` 环境变量指示的目
2222
* `content` 环境变量指示的目录下的所有文件/文件夹都是漫画的候选者
2323
* 相对路径是漫画的重要标识。这意味着如果一本漫画被移动到了别处,ComicLib 会认为这是另一本漫画;重新扫描时会跳过同一路径的漫画,除非 `skip_exists=False`;将漫画库整体移到别处并修改 `content` 环境变量保持相对关系不变则不需要重新扫描。
2424
* ComicLib 的主体仅负责遍历漫画库,漫画文件的判断都是通过[扫描脚本](scanner.md)完成的。当有一个[扫描脚本](scanner.md)承认该路径是漫画则计入数据库。
25-
* 漫画的元数据解析、缩略图提取也是由[扫描脚本](scanner.md)负责。
25+
* 漫画的元数据解析、缩略图提取也是由[扫描脚本](scanner.md)负责。
26+
* 在完整扫描时,若[扫描脚本](scanner.md)出错会停止整个扫描以让用户确定错误,但扫描进度得以保留。
27+
* 监视时遇到的错误会忽略。

0 commit comments

Comments
 (0)