Sphinx¶
轻松创建智能且美观的文档
📝 富文本格式
使用 reStructuredText 或 MyST Markdown 编写，以创建高度结构化的技术文档，包括表格、高亮代码块、数学符号等。
📚 多功能的文档格式
以你的受众首选的格式生成文档，包括 HTML、LaTeX (用于 PDF)、ePub、Texinfo、等。
🛠️ 自动 API 文档
为 Python、C++ 和其他 软件领域 生成 API 文档，可以手动或 从文档字符串自动生成，确保你的代码文档保持最新，且只需最少的努力。
🌍 国际化 (i18n)
添加文档 翻译 成多种语言，以覆盖全球受众。
🌟 活跃的社区和支持
受益于一个 活跃的社区，拥有大量的资源、教程、论坛和示例。
请参阅下文，了解如何浏览 Sphinx 的文档。
另请参阅
《Sphinx 文档目录》包含了本站页面的完整列表。
入门¶
这些章节涵盖了 Sphinx 入门的基础知识，包括从零开始创建和构建你自己的文档。
用户指南¶
这些章节涵盖了使用和扩展 Sphinx 以适应各种用例的各种主题。它们是关于在多种情况下使用 Sphinx 的综合指南，并假设你对 Sphinx 有更多了解。如果你是 Sphinx 的新手，我们建议从 入门 开始。
社区指南¶
Sphinx 由社区支持，并欢迎任何人的贡献。以下章节应该可以帮助你开始加入 Sphinx 社区并做出贡献。
如果你想为项目做贡献，请参阅《Sphinx 贡献者指南》。