Flatpak 文檔

flatpak-文檔

此儲存庫是 Flatpak 開發人員文件的主要來源。可以在 docs.flatpak.org 上閱讀。

一些文件也可以在 Flatpak wiki 上找到，並作為flatpak和flatpak-builder手冊頁的一部分。

這些文件是用 reStructuredText 編寫的，歡迎貢獻！

設定開發

創建Python虛擬環境：

 python3 -m venv .venv && 源 .venv/bin/activate

然後使用pip安裝依賴項：

 pip install -r 要求.txt

建構文檔

設定完成後，您可以建立文件：

 make -C 文件 html

運行測試：

 make -C 文件連結檢查

您可以執行 HTTP 伺服器並依照列印的連結 (localhost:8000) 在瀏覽器中檢視文件：

 python3 -m http.server -d docs/_build/html

建構翻譯

預設情況下，正在建置的文檔是英文的。如果你想建立其他語言的文檔，例如中文，可以使用以下指令：

 make -C docs html SPHINXOPTS='-D language=zh_CN'

翻譯文件

您可以開啟新增語言的拉取請求。

維護者可以透過執行以下命令來產生範本檔案 ( .pot )、更新翻譯檔案 ( .po ) 並刪除過時的翻譯檔案（即符合的.pot檔案不再存在）：

 make -C 文件更新-po

觀眾

桌面應用程式開發人員是 Flatpak 文件的主要受眾，特別是現有應用程式（包括來自非 Linux 平台的應用程式）的作者。

這些文件應盡可能反映受眾中的流行實踐，而不是假設應用程式來自 Linux 桌面空間。實際上，這意味著我們應該期望：

• Git 用於版本控制
• 用於託管的 GitHub
• 免費桌面運行時
• 事先不了解 Linux 桌面約定，例如.desktop檔案、AppStream 和 D-Bus

除了這些基本預設值之外，還應特別注意流行的跨平台技術，例如 Electron 和 Qt。

指南

對於那些想要為文件做出貢獻的人的指南：

• 解釋基本的 Flatpak 概念
• 專注於標準應用程式開發人員工作流程
• 使用文件解釋 Flatpak 的優點以及開發人員可能使用它的原因
• 僅涵蓋應用程式開發人員必需的內容 - 除非絕對必要，否則不要包含 Flatpak 內部的詳細信息
• 提供盡可能流暢、無摩擦的開發人員體驗
• 透過預測開發人員可能遇到的潛在問題並引導他們避開這些問題，幫助防止困難