博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
使用sphinx来创建文档
阅读量:6592 次
发布时间:2019-06-24

本文共 1058 字,大约阅读时间需要 3 分钟。

tag2txt 只生成单个html文档,比较合适写一些api或接口的文档,如果做大项目文档还是想使用sphinx

 

安装(需要安装python和easy_install)

easy_install sphinx

生成一个项目(按向导进行)

sphinx-quickstart

生成的文件&目录

-rw-r--r--  1 bluefrog bluefrog 7670 2012-05-28 16:32 conf.py-rw-r--r--  1 bluefrog bluefrog  417 2012-05-28 16:32 index.rst-rw-r--r--  1 bluefrog bluefrog 5092 2012-05-28 16:32 make.bat-rw-r--r--  1 bluefrog bluefrog 5556 2012-05-28 16:32 Makefiledrwxr-xr-x  2 bluefrog bluefrog 4096 2012-05-28 16:32 _static/drwxr-xr-x  2 bluefrog bluefrog 4096 2012-05-28 16:32 _templates/

编辑index.rst文件

.. test documentation master file, created by   sphinx-quickstart on Mon May 28 16:32:00 2012.   You can adapt this file completely to your liking, but it should at least   contain the root `toctree` directive.Welcome to test's documentation!================================Contents:.. toctree::   :maxdepth: 2Indices and tables==================* :ref:`genindex`* :ref:`modindex`* :ref:`search`

编译文档

mkdir docsphinx-build . doc

 

改天有空可以写一个简单的语法教程

注:python的文档就是使用sphinx来生成的

 

公司大牛有用php写了一个doczen  个人还是使用sphinx吧

使用 doczen 生成的示例:

转载地址:http://mfcio.baihongyu.com/

你可能感兴趣的文章
PPTP××× 数据分流
查看>>
mongodb 索引
查看>>
Citrix 宣布 XenServer 全面开源
查看>>
我的友情链接
查看>>
oracle 如果为空则输出0
查看>>
Spfa(最短路求解)
查看>>
使用linux-c编程实现简单的ls命令
查看>>
Q:按F12进行网络安装系统时,一直无法进入,提示加载失败?
查看>>
我的友情链接
查看>>
解决AutoCAD acmgd.dll ARX命令中发现异常
查看>>
[转]passport.js学习笔记
查看>>
10.31T3 其他算法思想
查看>>
JAVA API----Math类和Random类
查看>>
求js数组中最小值
查看>>
UVA10018 Reverse and Add
查看>>
7.16学习进度
查看>>
52、多线程创建的三种方式对比
查看>>
【转载】Jquery验证 Jquery.validate详细解读
查看>>
软件需求规格书
查看>>
用Java axis2调用.net平台的Webservice出现的一些问题
查看>>