优酷土豆青睐的搜索引擎Sphinx新功能:Python项目文档生成工具

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:


$ pip install Sphinx

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

使用示例

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

$ sphinx-quickstart

完整的上手说明请参考教程
希望大家能够喜欢,有问题欢迎在评论区留言

点击居然老师公开课视频播放地址

    原文作者:扒皮狼
    原文地址: https://www.jianshu.com/p/e2828feaa88d
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞