Sphinx:Python项目文档生成工具

screenshot

Sphinx能为Python项目创建智能且美观的文档,由Georg Brandl编写,BSD许可证。Sphinx最初是为新版本Python文档https://docs.python.org/3/创建的,目前已经支持C/C++,计划添加其他语言支持。

了解更多请查看官方文档

功能特点

  • 输出格式:HTML(包括Windows HTML帮助),LaTeX(用于可打印的PDF版本),ePub,Texinfo,手册页,纯文本
  • 可扩展的交叉引用:为函数,类,引文,词汇术语等信息自动创建语义标记和链接
  • 分层结构:很方便定义文档的树状结构,自动链接同级和下级文档
  • 自动索引:支持一般索引和特定语言模块索引
  • 代码处理:使用Pygments库自动对代码进行高亮显示
  • 扩展:自动检测代码片段,包含来自Python模块的docstring(API文档)等
  • 社区扩展:超过50个用户贡献的扩展,其中大多数可以通过PyPI安装

安装

用pip安装Sphinx:

Linux、Windows、MAC本地安装请参考这里

使用示例

创建文档目录及默认配置文件conf.py:

完整的上手说明请参考教程

开发资源

官方网站:http://www.sphinx-doc.org/en/latest/
开源地址:https://github.com/sphinx-doc/sphinx/

1 收藏

资源整理者简介:硕恩

简介还没来得及写 :) 个人主页 · 贡献了3个资源 · 1


直接登录

推荐关注

按分类快速查找

关于资源导航
  • 伯乐在线资源导航收录优秀的工具资源。内容覆盖开发、设计、产品和管理等IT互联网行业相关的领域。目前已经收录 1438 项工具资源。
    推送伯乐头条热点内容微信号:jobbole 分享干货的技术类微信号:iProgrammer