推荐学习书目
› 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
sqbing
V2EX  ›  Python

用什么工具编写文档?

  •  
  •   sqbing ·
    sqbing · May 29, 2011 · 7332 views
    This topic created in 5604 days ago, the information mentioned may be changed or developed.
    你平时用什么工具维护代码的文档?
    7 replies  •  2019-10-30 18:53:25 +08:00
    chone
        1
    chone  
       May 29, 2011
    python文档通常是自述的,不需要javadoc什么那样的,直接从代码就能查看相关文档。
    http://diveintopython.org/power_of_introspection/index.html
    fly2never
        2
    fly2never  
       May 29, 2011
    @chone javadoc也可以写在代码里面,然后通过工具生成出来
    icyflash
        3
    icyflash  
       May 29, 2011
    加注释,自动生成
    chone
        4
    chone  
       May 29, 2011
    @fly2never 我的意思就是不用像那样,单独生成一个文档,python的源代码就是文档,python自身提供了相关的查看方法,在代码里做好注释就行了,这个被称为Introspection。
    jjgod
        5
    jjgod  
       May 30, 2011
    在这里问,当然是 Sphinx 了。
    sqbing
        6
    sqbing  
    OP
       May 30, 2011
    @icyflash 是的,我就是想自动生成的PDF或者html格式的文档
    balabalaguguji
        7
    balabalaguguji  
       Oct 30, 2019
    你可以试下易文档,这个很好用 https://easydoc.top
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   2429 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 33ms · UTC 06:32 · PVG 14:32 · LAX 23:32 · JFK 02:32
    ♥ Do have faith in what you're doing.