建立你的第一個專案¶
在本教學中,你將會使用 Sphinx 建立一個簡單的文件專案,並在瀏覽器中以 HTML 格式檢視。此專案將包含敘述式的手寫文件,以及自動產生的 API 文件。
本教學旨在引導 Sphinx 新手學習專案建立和架構的基本原理。你將會建立一個虛構的軟體函式庫,用以產生隨機食物食譜,作為貫穿整個過程的指南,目標是正確地記錄它。
為了展示 Sphinx 在程式碼文件方面的能力,你將使用 Python,它也支援*自動*文件產生。
注意
Sphinx 原生支援多種其他語言的*手動*程式碼文件,但它們需要擴充套件才能進行*自動*程式碼文件,例如 Breathe。
為了遵循這些指示,你需要存取類似 Linux 的命令列,並對其運作方式有基本的了解,以及用於開發的 Python 工作環境,因為你將使用 *Python 虛擬環境* 來建立專案。