求推荐 Sphinx 的使用教程

2020-07-07 07:37:31 +08:00
 vcfghtyjc

最近需要用为 Python 项目写文档,但是 Sphinx 官方文档看的我云里雾里,各位能否推荐一个易懂的教程?

最好是手把手一步步的那种。

2081 次点击
所在节点    Python
3 条回复
ericls
2020-07-07 08:08:18 +08:00
找个项目的现成配置看看吧
这是我某个小项目的文档 https://github.com/ericls/django-simple-task/tree/master/docs
siteshen
2020-07-07 11:34:02 +08:00
1. 按照 quick-start 生成配置,编译并查看基本文档
2. 研究如何递归地生成模块文档
3. 研究配置特定插件(如 Django Flask gRPC 等)
4. 规划文档架构( Quick Start / Tutorial / References),编写 rst 文件
gjquoiai
2020-07-09 00:35:32 +08:00
rst 真的不太友好。。如果不是为了从注释生成文档的话,可以试试 mkdocs 。。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/687753

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX