Sphinx¶
輕鬆建立智慧且美觀的文件
📝 豐富文字格式
使用 reStructuredText 或 MyST Markdown 撰寫，以建立高度結構化的技術文件，包括表格、醒目提示的程式碼區塊、數學符號等等。
📚 多功能文件格式
以您的受眾偏好的格式產生文件，包括 HTML、LaTeX (用於 PDF)、ePub、Texinfo、以及更多。
🛠️ 自動 API 文件
為 Python、C++ 和其他軟體領域產生 API 文件，可以手動或從 docstrings 自動產生，確保您的程式碼文件保持最新，且只需最少的努力。
🌍 國際化 (i18n)
新增文件翻譯多種語言，以接觸全球受眾。
🌟 活躍的社群和支援
受益於活躍的社群，提供眾多資源、教學、論壇和範例。
請參閱下方說明，了解如何瀏覽 Sphinx 的文件。
參見
Sphinx 文件目錄包含本網站所有頁面的完整列表。
開始使用¶
這些章節涵蓋 Sphinx 入門的基礎知識，包括從頭開始建立和建置您自己的文件。
使用者指南¶
這些章節涵蓋使用和擴展 Sphinx 以用於各種使用案例的各種主題。它們是使用 Sphinx 在許多情境中的綜合指南，並假設您對 Sphinx 有更多了解。如果您是 Sphinx 的新手，我們建議從開始使用開始。
社群指南¶
Sphinx 是社群支援的，歡迎任何人的貢獻。以下章節應可協助您開始加入 Sphinx 社群以及做出貢獻。
如果您想為專案做出貢獻，請參閱Sphinx 貢獻者指南。
參考指南¶
參考文件在本質上更完整且更著重程式設計，它是可以快速參考的資訊集合。如果您想要以使用案例驅動的文件，請參閱開始使用或使用者指南。