Sphinx¶

輕鬆建立智慧且美觀的文件

📝 豐富的文字格式

使用 reStructuredText 或 MyST Markdown 撰寫，以建立高度結構化的技術文件，包括表格、醒目顯示的程式碼區塊、數學符號等等。

🔗 強大的交叉參考

在您的專案內建立交叉參考，甚至跨不同專案。包含章節、圖形、表格、引文、詞彙表、程式碼物件等的參考。

📚 多功能的文件格式

以您的受眾偏好的格式產生文件，包括 HTML、LaTeX (用於 PDF)、ePub、Texinfo、以及更多。

🎨 廣泛的主題支援

建立視覺上吸引人的文件，有多種內建和第三方 HTML 主題可供選擇，並且能夠自訂或建立新主題。

🔌 完全可擴充

透過強大的擴充機制新增自訂功能，並有眾多內建和第三方擴充功能可用於建立圖表、測試程式碼等任務。

🛠️ 自動 API 文件

為 Python、C++ 和其他軟體領域產生 API 文件，可以手動或從 docstring 自動產生，確保您的程式碼文件保持最新，且只需最少的努力。

🌍 國際化 (i18n)

新增文件翻譯成多種語言，以接觸全球受眾。

🌟 活躍的社群和支援

受益於活躍的社群，擁有眾多資源、教學、論壇和範例。

使用者

Python¶

Linux Kernel¶

Project Jupyter¶

請參閱下方說明，了解如何導覽 Sphinx 的文件。

參見

Sphinx 文件目錄有本網站頁面的完整列表。

開始使用¶

這些章節涵蓋 Sphinx 入門的基礎知識，包括從頭開始建立和建置您自己的文件。

這些章節涵蓋使用和擴充 Sphinx 以用於各種使用案例的各種主題。它們是使用 Sphinx 在許多情境中的綜合指南，並假設您對 Sphinx 有更多了解。如果您是 Sphinx 的新手，我們建議從開始使用開始。

Sphinx 由社群支援，並歡迎任何人的貢獻。以下章節應有助於您開始加入 Sphinx 社群以及做出貢獻。

如果您想為專案做出貢獻，請參閱Sphinx 貢獻者指南。

社群

參考文件本質上更完整且更具程式化，它是一個可以快速參考的資訊集合。如果您想要以使用案例驅動的文件，請參閱開始使用或使用者指南。

參考