Sphinx 文档目录

Get started

• 入门
  • 初始化文档源目录
  • 定义文档结构
  • 添加内容
  • 运行生成程序
  • 给对象写文档
    • enumerate()
  • 基本配置
  • 使用 autodoc 自动生成文档
  • 跨 Sphinx 引用
  • 其他常用功能举例
• 安装Sphinx
  • 概述
  • Linux
    • Debian/Ubuntu
    • RHEL, CentOS
    • 其他发行版
  • macOS
    • Homebrew
    • MacPorts
    • Anaconda
  • Windows
    • Chocolatey
    • 其他方法
  • 从PyPI安装
    • Using virtual environments
  • Docker
  • 从源代码安装
• Tutorial: Build your first project
  • 开始
    • Setting up your project and development environment
    • Creating the documentation layout
  • First steps to document your project using Sphinx
    • Building your HTML documentation
    • Building your documentation in other formats
  • More Sphinx customization
    • Enabling a built-in extension
    • Using a third-party HTML theme
  • Narrative documentation in Sphinx
    • Structuring your documentation across multiple pages
    • Adding cross-references
  • Describing code in Sphinx
    • Python
    • Other languages (C, C++, others)
  • Automatic documentation generation from code
    • Reusing signatures and docstrings with autodoc
    • Generating comprehensive API references
  • Appendix: Deploying a Sphinx project online
    • Sphinx-friendly deployment options
    • Embracing the “Docs as Code” philosophy
    • Publishing your documentation sources
    • Publishing your HTML documentation
  • Where to go from here

User Guides

• 使用sphinx
  • reStructuredText
    • reStructuredText 初级入门
    • 角色
    • 指令
    • 字段列表
    • MOVED: Domains
  • Markdown
    • 配置
  • 交叉引用语法
    • 交叉引用任何内容
    • 交互参考对象
    • 交叉引用任意位置
    • 交叉引用文件
    • 引用可下载文件
    • 图号对照图
    • 交叉引用其他感兴趣的项目
  • 配置
    • 项目信息
    • 一般配置
    • 国际化选项
    • 数学选项
    • HTML输出选项
    • 单个HTML输出的选项
    • HTML帮助输出选项
    • Apple帮助输出选项
    • epub输出的选项
    • LaTeX输出的选项
    • 文本输出选项
    • 手动页面输出选项
    • Texinfo输出的选项
    • QtHelp输出的选项
    • linkcheck生成器的选项
    • XML生成器的选项
    • C域选项
    • C++ 域选项
    • Options for the Python domain
    • Options for the Javascript domain
    • 配置文件示例
  • 生成器
    • StandaloneHTMLBuilder
    • DirectoryHTMLBuilder
    • SingleFileHTMLBuilder
    • HTMLHelpBuilder
    • QtHelpBuilder
    • AppleHelpBuilder
    • DevhelpBuilder
    • Epub3Builder
    • LaTeXBuilder
    • TextBuilder
    • ManualPageBuilder
    • TexinfoBuilder
    • SerializingHTMLBuilder
    • PickleHTMLBuilder
    • JSONHTMLBuilder
    • MessageCatalogBuilder
    • ChangesBuilder
    • DummyBuilder
    • CheckExternalLinksBuilder
    • XMLBuilder
    • PseudoXMLBuilder
    • 序列化生成器详细信息
  • 域
    • 基本标记
    • Built-in domains
    • 更多域
  • 插件
    • 内置插件
    • 第三方插件
  • HTML 主题
    • 生成器
    • 主题
  • 国际化
    • sphinx国际化细节
    • 用sphinx国际翻译
    • 使用Transifex服务进行团队翻译
    • Using Weblate service for team translation
    • 有助于sphinx参考翻译
    • Translation progress and statistics
  • Sphinx Web支持
    • Web支持快速入门
    • Web支持类
    • 搜索适配器
    • 存储后端
• Writing Sphinx Extensions
  • 开发扩展概述
    • 使一个扩展依赖于另一个扩展
  • 扩展教程
    • 开发了一个 “Hello world” 扩展
    • Developing a “TODO” extension
    • 开发“开发“食谱”扩展名
    • 为IntEnum开发autodoc 插件
  • 配置构建器
    • 通过入口点发现构建器
  • 模板
    • 我需要使用Sphinx的模板来生成HTML吗？
    • Jinja/Sphinx模板
    • 使用内置模板
  • HTML theme development
    • 创建主题
    • 将主题作为Python包分发
    • 模板
• LaTeX个性化
  • “latex_elements”配置设置
  • “sphinxsetup”配置设置
  • Additional CSS-like 'sphinxsetup' keys
  • LaTeX宏和环境
    • 宏
    • The \sphinxbox command
    • 环境
    • 杂项
• Sphinx Extensions API
  • 重要对象
  • 构建阶段
  • 扩展元数据
  • 用于编写插件的接口
    • 应用接口
    • 项目接口
    • 生成环境接口
    • 生成器接口
    • 环境收集器 API
    • Docutils标记接口
    • 域接口
    • 解析器接口
    • Sphinx添加的Doctree节点类
    • 日志接口
    • i18n接口
    • 公用程序
    • 弃用的接口

社区

• Get support
• Contribute to Sphinx
  • 对sphinx的贡献
    • Get help
    • 错误报告和功能请求
    • Contribute code
    • Contribute documentation
    • 调试小贴士
  • sphinx的释放过程
    • Versioning
    • 弃用功能
    • 弃用政策
    • Python version support policy
    • 释放程序
  • sphinx项目的组织
    • 核心开发者
    • 其他贡献者
  • sphinx行为准则
• Sphinx常见问题解答
  • 我该如何…
  • 用…使用sphinx
  • Sphinx 和 Docutils
  • Epub信息
  • Texinfo信息
    • 展示链接
    • 提示
• Sphinx 作者
  • 维护者
  • 贡献者
  • Former maintainers

Reference

• Command-Line Tools
  • 核心应用
    • sphinx-quickstart
    • sphinx-build
  • 附加应用
    • sphinx-apidoc
    • sphinx-autogen
• 配置
  • 项目信息
  • 一般配置
  • 国际化选项
  • 数学选项
  • HTML输出选项
  • 单个HTML输出的选项
  • HTML帮助输出选项
  • Apple帮助输出选项
  • epub输出的选项
  • LaTeX输出的选项
  • 文本输出选项
  • 手动页面输出选项
  • Texinfo输出的选项
  • QtHelp输出的选项
  • linkcheck生成器的选项
  • XML生成器的选项
  • C域选项
  • C++ 域选项
  • Options for the Python domain
  • Options for the Javascript domain
  • 配置文件示例
• 插件
  • 内置插件
    • ：模式：sphinx.ext.autodoc–包括来自docstrings的文档
    • ：模式：sphinx.ext.autosectionlabel–允许引用节使用其标题
    • ：模式：sphinx.ext.自动摘要–生成自动文档摘要
    • ：模式：sphinx.ext.coverage–收集文档覆盖率统计
    • ：模式：sphinx.ext.doctest–文档中的测试片段
    • ：模式：sphinx.ext.duration——测量Sphinx加工的持续时间
    • ：模式：sphinx.ext.extlinks–标记以缩短外部链接
    • ：模式：sphinx.ext.githubpages–在GitHub页面中发布HTML文档
    • ：模式：sphinx.ext.graphviz–添加Graphviz图
    • ：模式：sphinx.ext.ifconfig–根据配置包含内容
    • ：模式：sphinx.ext.imgconverter–使用Imagemagick的参考图像转换器
    • ：模式：sphinx.ext.继承图–包括继承关系图
    • ：模式：sphinx.ext.intersphinx–链接到其他文档
    • ：模式：sphinx.ext.linkcode–向源代码添加外部链接
    • Sphinx中HTML输出的数学支持
    • ：模式：sphinx.ext.napoleon——支持NumPy和Google风格的文档字符串
    • ：模式：sphinx.ext.todo–支持todo项
    • ：模式：sphinx.ext.viewcode–添加指向突出显示的源代码的链接
  • 第三方插件
    • 你自己的插件放在哪里？
• reStructuredText
  • reStructuredText 初级入门
    • 段落
    • 行内标记
    • 列表、引用及其他区块样式
    • 文字块
    • doctest块
    • 表格
    • 超链接
    • 章节
    • 字段列表
    • 角色
    • 显式标记
    • 指令
    • 图片
    • 脚注
    • 引文
    • 替代品
    • 注释
    • HTML 元数据
    • 源编码
    • 陷阱
  • 角色
    • 交叉引用语法
    • Inline code highlighting
    • 数学
    • 其他语义标记
    • 替代品
  • 指令
    • 目录
    • 段落级标记
    • 显示代码示例
    • 术语表
    • 元信息标记
    • 索引生成标记
    • 包括基于标签的内容
    • 表格
    • 数学
    • 语法生成显示
  • 字段列表
    • 文件范围元数据
    • 特殊的元数据字段
  • MOVED: Domains
    • MOVED: Basic Markup
    • MOVED: Python Domain
    • MOVED: C Domain
    • MOVED: C++ Domain
    • MOVED: Standard Domain
    • MOVED: JavaScript Domain
    • MOVED: reStructuredText Domain
    • MOVED: Math Domain
    • MOVED: More domains
• 术语表
• 更新日志
• 使用Sphinx的项目
  • 使用alabaster主题的文档
  • 使用经典主题的文档
  • 使用sphinxdoc主题的文档
  • 使用自然主题的文档
  • 使用另一个内置主题的文档
  • 使用sphinx_rtd_主题的文档
  • 使用sphinx_bootstrap_主题的文档
  • Documentation using pydata_sphinx_theme
  • 使用自定义主题或集成在网站中的文档
  • 主页和其他非文档网站
  • 用sphinx制作的书籍
  • 用sphinx撰写的论文
  • 集成Sphinx功能的项目