Sphinx¶

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

📝 富文字格式

Author in reStructuredText or MyST Markdown to create highly structured technical documents, including tables, highlighted code blocks, mathematical notations, and more.

🔗 強大的交叉參照

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

📚 Versatile Documentation Formats

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

🎨 廣泛的主題支援

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

🔌 Fully Extensible

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 文件

Generate API documentation for Python, C++ and other software domains, manually or automatically from docstrings, ensuring your code documentation stays up-to-date with minimal effort.

🌍 國際化（i18n）

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

🌟 活躍的社群與支援

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

As used by:

Python¶

Linux 內核¶

Jupyter 專案¶

See below for how to navigate Sphinx's documentation.

另請參見

The Sphinx documentation Table of Contents has a full list of this site's pages.

開始使用¶

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 is community supported and welcomes contributions from anybody. The sections below should help you get started joining the Sphinx community as well as contributing.

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 使用者指南.

參考手冊