跳转到主要内容

Python文档生成器

项目描述

Package on PyPI Build Status Documentation Status BSD 2 Clause

Sphinx使创建智能和美观的文档变得简单。

Sphinx 使用 reStructuredText 作为其标记语言,其许多优势来自于 reStructuredText 的强大和简洁,以及其解析和转换套件 Docutils。

功能

  • 输出格式:HTML、PDF、纯文本、EPUB、TeX、手册页等

  • 广泛的交叉引用:语义标记和函数、类、术语表条目等类似信息的自动链接

  • 层次结构:易于定义文档树,具有到兄弟姐妹、父亲和子节点的自动链接

  • 自动索引:一般索引以及模块索引

  • 代码高亮显示:使用 Pygments 高亮显示器自动高亮显示

  • 模板化:使用 Jinja 2 模板引擎的灵活 HTML 输出

  • 扩展生态系统:提供许多扩展,例如自动函数文档或与 Jupyter 笔记本一起使用。

  • 语言支持:通过扩展支持 Python、C、C++、JavaScript、数学等许多其他语言。

有关更多信息,请参阅文档

安装

以下命令从Python 包索引安装 Sphinx。您需要一个有效的 Python 和 pip 安装。

pip install -U sphinx

贡献

我们感谢所有贡献!有关信息,请参阅贡献指南

发布历史 发布通知 | RSS 源

下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源代码分发

sphinx-8.0.2.tar.gz (8.2 MB 查看哈希值)

上传时间 源代码

构建分发

sphinx-8.0.2-py3-none-any.whl (3.5 MB 查看哈希值)

上传时间 Python 3

由以下支持