用什么工具编写文档?

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

这是一个创建于 4715 天前的主题，其中的信息可能已经有所发展或是发生改变。

你平时用什么工具维护代码的文档?

文档

工具

编写

7 条回复 • 2019-10-30 18:53:25 +08:00

chone

2011-05-29 12:42:11 +08:00

python文档通常是自述的，不需要javadoc什么那样的，直接从代码就能查看相关文档。
http://diveintopython.org/power_of_introspection/index.html

fly2never

2011-05-29 13:20:39 +08:00

@chone javadoc也可以写在代码里面,然后通过工具生成出来

icyflash

2011-05-29 13:36:24 +08:00

加注释，自动生成

chone

2011-05-29 14:21:03 +08:00

@fly2never 我的意思就是不用像那样，单独生成一个文档，python的源代码就是文档，python自身提供了相关的查看方法，在代码里做好注释就行了，这个被称为Introspection。

jjgod

2011-05-30 01:27:46 +08:00

在这里问，当然是 Sphinx 了。

sqbing

2011-05-30 08:02:24 +08:00

@icyflash 是的，我就是想自动生成的PDF或者html格式的文档

balabalaguguji

2019-10-30 18:53:25 +08:00

你可以试下易文档，这个很好用 https://easydoc.top