V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
推荐学习书目
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
vcfghtyjc
V2EX  ›  Python

求推荐 Sphinx 的使用教程

  •  
  •   vcfghtyjc · 2020-07-07 07:37:31 +08:00 · 1938 次点击
    这是一个创建于 1360 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

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

    3 条回复    2020-07-09 00:35:32 +08:00
    ericls
        1
    ericls  
       2020-07-07 08:08:18 +08:00
    找个项目的现成配置看看吧
    这是我某个小项目的文档 https://github.com/ericls/django-simple-task/tree/master/docs
    siteshen
        2
    siteshen  
       2020-07-07 11:34:02 +08:00
    1. 按照 quick-start 生成配置,编译并查看基本文档
    2. 研究如何递归地生成模块文档
    3. 研究配置特定插件(如 Django Flask gRPC 等)
    4. 规划文档架构( Quick Start / Tutorial / References),编写 rst 文件
    gjquoiai
        3
    gjquoiai  
       2020-07-09 00:35:32 +08:00
    rst 真的不太友好。。如果不是为了从注释生成文档的话,可以试试 mkdocs 。。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   4906 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 09:51 · PVG 17:51 · LAX 02:51 · JFK 05:51
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.