最近需要用为 Python 项目写文档，但是 Sphinx 官方文档看的我云里雾里，各位能否推荐一个易懂的教程？
最好是手把手一步步的那种。
推荐学习书目
› Learn Python the Hard Way
Python Sites
› PyPI - Python Package Index
› http://diveintopython.org/toc/index.html
› Pocoo
值得关注的项目
› PyPy
› Celery
› Jinja2
› Read the Docs
› gevent
› pyenv
› virtualenv
› Stackless Python
› Beautiful Soup
› 结巴中文分词
› Green Unicorn
› Sentry
› Shovel
› Pyflakes
› pytest
Python 编程
› pep8 Checker
Styles
› PEP 8
› Google Python Style Guide
› Code Style from The Hitchhiker's Guide
This topic created in 2145 days ago, the information mentioned may be changed or developed.
 |
1
ericls Jul 7, 2020
找个项目的现成配置看看吧
这是我某个小项目的文档 https://github.com/ericls/django-simple-task/tree/master/docs |
 |
2
siteshen Jul 7, 2020
1. 按照 quick-start 生成配置，编译并查看基本文档
2. 研究如何递归地生成模块文档 3. 研究配置特定插件（如 Django Flask gRPC 等） 4. 规划文档架构（ Quick Start / Tutorial / References)，编写 rst 文件 |
 |
3
gjquoiai Jul 9, 2020
rst 真的不太友好。。如果不是为了从注释生成文档的话，可以试试 mkdocs 。。
|
Select Language