rst是一种用于文本数据的文件格式,主要作袜闹为phthon编程语言技术文档的描述语言,其旨神好樱在为python创建一组类似于jave功能说明文档。
两类文档:1) 程序员用败码的rest api文档用rst格式书写,
2)其他一些如deployers, admins, and CLI and API users用Docbook书写,
如果想要将rst文件生成html或者其和核他什么格式的话,需要安装python的sphinx模块,安装方法:pip install sphinx
一个关于sphinx的文档参见:http://code.google.com/p/pymotwcn/wiki/SphinxprojectHowto
1) 安装sphinx后,运行命令“sphinx-quickstart”可生成一个doc project,生成后的工程目录形如:
[hua@zhanghua tmp]$ ls
_build conf.py index.rst make.bat Makefile output _static _templates
2) 可用 sphinx-build -b html . output 或者 make html命令生成html文档,生成的文档位于output目录
[hua@zhanghua tmp]$ ls output/
察棚哪genindex.html index.html objects.inv search.html searchindex.js _sources _static
3) 将上面的rst文档例子test.rst作为链接添加到index.rst中来
Contents:
.. toctree::
:maxdepth: 2
doc/test.rst
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)