sphinx-for-python

1、安装:

http://gisellezeno.com/tutorials/sphinx-for-python-documentation.html

pip install sphinx

2、使用命令:sphinx-quickstart

试参考示例:

https://pythonhosted.org/an_example_pypi_project/sphinx.html


3、docs/source/conf.py文件中将下面一句注释消去写上相对目录:

sys.path.insert(0, os.path.abspath('../..'))

4、生成.rst文件:

sphinx-apidoc-f-o source/ ../mypackage/

将生成的.rst 文件添加到index.rst中:

 

生成html文件:

make html

python代码格式参考:

https://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example





  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值