python项目用sphinx文档生成

seanHai 发布于2019-07-24 17:33 / 1180人阅读

摘要：项目用文档生成使用内置命令得到文件自己编辑或者加上然后直接注意需要在里面加入项目路径让他能够如果路径很深需要后面参数根据情况

python项目用sphinx文档生成 使用内置命令

sphinx-apidoc -o doc waterfal
得到 rst 文件

localhost:doc timger$ ls
modules.rst             waterfall.glblog.rst    waterfall.master.rst    waterfall.rst
waterfall.excepts.rst   waterfall.lib.rst       waterfall.p2plog.rst    waterfall.slowspeed.rst

自己编辑 conf.py
或者加上 -F

localhost:waterfall timger$ sphinx-apidoc -F -o doc waterfall
Creating file doc/waterfall.rst.
Creating file doc/waterfall.excepts.rst.
Creating file doc/waterfall.glblog.rst.
Creating file doc/waterfall.lib.rst.
Creating file doc/waterfall.master.rst.
Creating file doc/waterfall.p2plog.rst.
Creating file doc/waterfall.slowspeed.rst.
Creating file doc/conf.py.
Creating file doc/index.rst.
Creating file doc/Makefile.
Creating file doc/make.bat.

然后直接 make html

注意需要在 conf.py 里面加入项目路径让他能够 import

如果路径很深需要 -d 10 后面参数根据情况

GPU云服务器云服务器 python生成文档 python文档生成文档生成生成API文档

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/37313.html

使用 Sphinx 撰写技术文档并生成 PDF 总结

摘要：项目代码认识是一个基于的文档生成项目。文档项目起始文件。将之前的文档用管理，并推送到，然后在中即可。完成后使用更新。设置文档你的第一本书作者最后，编译会完成转换为并将生成，可以手动分开在下可以查看到生成的文档。这几天准备编排部分翻译的书籍和文档，找了好些工具，最终定格在 Sphinx 上，并基于 ReadTheDocs 提供的 SaaS 服务进行分发和分享。本篇博客是对整个过程的一次...

sutaking 2019-07-31 10:06 评论0 收藏0
sphinx快速入门

摘要：简介是一个用于快速生成文档的工具，非常适合生成文档。称之为主文档，它被作为欢迎页面。由于是默认的域，所以并不需要特别指出所属的域来。自动生成文档注释支持从源代码中提取文档注释信息，然后生成文档，我们将这称之为。简介 sphinx是一个用于快速生成文档的工具，非常适合生成Python文档。它具有以下优点：支持多种输出格式，如html，Latex，ePub等。丰富的扩展结构化...

yexiaobai 2019-07-25 10:54 评论0 收藏0
php + MongoDB + Sphinx 实现全文检索

摘要：此文成于年月现状目前的稳定版本为目前对英文等字母语言采用空格分词故其对中文分词支持不好目前官方中文分词方案仅支持按单字分词在基础上目前国内有两个中文分词解决方案一个是一个是没有官网文档较少可查到的最新版本可支持官方还在维护但貌似不打 NOTE : 此文成于 2017 年 3 月. 现状: Sphinx 目前的稳定版本为 2.2.11.Sphinx 目前对英文等字母语言采用空格分词,故...

Simon_Zhou 2019-06-26 17:38 评论0 收藏0
php + MongoDB + Sphinx 实现全文检索

摘要：此文成于年月现状目前的稳定版本为目前对英文等字母语言采用空格分词故其对中文分词支持不好目前官方中文分词方案仅支持按单字分词在基础上目前国内有两个中文分词解决方案一个是一个是没有官网文档较少可查到的最新版本可支持官方还在维护但貌似不打 NOTE : 此文成于 2017 年 3 月. 现状: Sphinx 目前的稳定版本为 2.2.11.Sphinx 目前对英文等字母语言采用空格分词,故...

dockerclub 2019-06-28 18:43 评论0 收藏0