Sphinx¶

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

📝 富文字格式

在 reStructuredText 或 MyST Markdown 中撰寫，建立結構嚴謹的技術文件，包括表格、標明的程式碼區塊、數學符號等更多功能。

🔗 強大的交叉參照

Create cross-references within your project, and even across different projects. Include references to sections, figures, tables, citations, glossaries, code objects, and more.

📚 多樣化的文件格式

以您的受眾偏好的格式生成文件，包括 HTML、LaTeX（用於 PDF）、ePub、Texinfo 等等。

🎨 廣泛的主題支援

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

🔌 完全可擴充性

Add custom functionality, via robust extension mechanisms with numerous built-in and third-party extensions available for tasks like creating diagrams, testing code, and more.

🛠️ 自動化 API 文件

為 Python、C++ 及其他軟體領域生成 API 文件，可手動或從文件字串自動生成，確保您的程式碼文件以最小努力保持最新狀態。

🌍 國際化（i18n）

增添多種語言的文件翻譯以覆蓋全球受眾。

🌟 活躍的社群與支援

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

As used by:

Python¶

Linux 內核¶

Jupyter 專案¶

See below for how to navigate Sphinx's documentation.

另請參見

Sphinx 文件目次表提供了該網站頁面的完整列表。

開始使用¶

These sections cover the basics of getting started with Sphinx, including creating and building your own documentation from scratch.

使用者指南¶

These sections cover various topics in using and extending Sphinx for various use-cases. They are a comprehensive guide to using Sphinx in many contexts and assume more knowledge of Sphinx. If you are new to Sphinx, we recommend starting with 開始使用.

社群指南¶

Sphinx 由社群提供支援，並歡迎任何人的貢獻。以下章節將幫助您加入 Sphinx 社群並開始貢獻。

See the Sphinx contributors' guide if you would like to contribute to the project.

社群

參考指南¶

Reference documentation is more complete and programmatic in nature, it is a collection of information that can be quickly referenced. If you would like usecase-driven documentation, see 開始使用 or 使用者指南.

參考手冊