8000 Add new make lint command in the doc. by cschan1828 · Pull Request #741 · python/python-docs-zh-tw · GitHub
[go: up one dir, main page]

Skip to content

Add new make lint command in the doc. #741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,12 +138,18 @@ the PSF for inclusion in the documentation.

poedit glossary.po

3. 存檔以後,執行以下列指令編譯輸出文件,以確保你的修改沒有 rST 的語法錯誤或警告 ::
3. 存檔以後,執行以下列指令編譯輸出完整文件,以確保你的修改沒有 reST 的語法錯誤或警告 ::

VERSION=3.12 make all

或者只想快速檢查是否有 reST 語法錯誤 ::

VERSION=3.12 make lint

確保輸出中沒有任何關於正在翻譯的檔案的警告訊息。

如果你還沒有執行 `維護、預覽`_ 的 clone CPython 的動作,此指令會自動幫你 clone CPython,\
並且會使用 Sphinx 幫你檢查 rST 語法錯誤,我們盡量保持沒有 warning \
並且會使用 Sphinx 幫你檢查 reST 語法錯誤,我們盡量保持沒有 warning \
的狀態,因此如果有出現 warning 的話請修復它。另外也記得檢查是否符合\
`翻譯守則`_

Expand Down Expand Up @@ -252,11 +258,11 @@ po 檔皆為首要的翻譯對象。你也可以幫忙校對已經翻譯過的
- 在本情況使用 ``zip(*[iter(x)]*n)`` 是很常見的情況(Python 慣例)。
- 在超文件標示語言 (HTML) 中應注意跳脫符號。

rST 語法注意事項
reST 語法注意事項
----------------

- ``:xxx:`...``` 即為 rST 的語法,應該在譯文中保留。
- rST 諸多語法需要保留前後的空白。在中文裡,該空白可以用 :literal:`\\\ \ `
- ``:xxx:`...``` 即為 reST 的語法,應該在譯文中保留。
- reST 諸多語法需要保留前後的空白。在中文裡,該空白可以用 :literal:`\\\ \ `
來取代,製造一個沒有寬度的分隔符號。

例如:
Expand Down
0