python生成api文档_sphinx生成python文档

**sphinx比较适合为Python生成文档**

1.安装sphinx

```shell

pip install sphinx sphinx-autobuild sphinx_rtd_theme

```

2.python文件的注释

可以注释如下：

```python

def Method(param1, param2):

"""

This is a reST style.

:param param1: this is a first param

:param param2: this is a second param

:returns: this is a description of what is returned

:raises keyError: raises an exception

"""

```

rst的API文档关键字：

```

param, parameter, arg, argument, key, keyword: Description of a parameter.

type: Type of a parameter. Creates a link if possible.

raises, raise, except, exception: That (and when) a specific exception is raised.

var, ivar, cvar: Description of a variable.

vartype: Type of a variable. Creates a link if possible.

returns, return: Description of the return value.

rtype: Return type. Creates a link if possible.

```

3.生成API文档

1. 在代码文件夹中建立：docs文件夹

2. 在docs文件夹运行`sphinx-quickstart`, 在之后的选项中autodoc设为y

3. 编辑`conf.py`.

```python

import os

import sys

sys.path.insert(0, os.path.abspath('../')) #设置根目录

import sphinx_rtd_theme

html_theme = 'sphinx_rtd_theme'

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

```

4. 运行`sphinx-apidoc -o ./ ../`

5. `make html`

6. 在_build中会有生成的html文件

python生成api文档_sphinx生成python文档相关推荐

php 在线api文档生成,api在线管理，调试，文档生成工具之Apizza
摘要: Apizza (http://apizza.cc?f=bl) 是国内领先的在线API saas 管理平台,支持在线的API调试,接口管理,快速生成文档,项目管理以及分享. 平台分为开发模式和浏 ...
python rest api 测试_如何用Python编写REST API的单元测试
在过去的几个月中,正在从事一个名为B的项目.它是带有简单Web UI的徽章生成器,用于添加数据并生成PDF可打印徽章.B后端现在已转移到REST-API并测试REST-API中使用的功能,我们需要一些 ...
python爬虫api接口,网易云音乐python爬虫api接口
抓包能力有限,分析了一下网易云音乐的一些api接口,但是关于它很多post请求都是加了密,没有弄太明白.之前在知乎看到过一个豆瓣工程师写的教程,但是被投诉删掉了,请问有网友fork了的吗?因为我觉得他 ...
url短网址 java_url.cn短网址生成api接口（腾讯短链接url生成）
分享几个最新的url.cn短网址生成api接口,快速生成url.cn超短链接,接口都可以正常调用,觉得不错可以收藏一下. 请求地址: 使用说明: 将api接口地址中"http://www.b ...
天行数据 api 接口数据搜索问题 -- Python 版本
2019/12/3 天行数据"垃圾分类" Python 版 api 接口问题.(Python 版本.中文字符) 天行数据提供 api 接口,利用这些可以做一些事情,比如做个Web端 ...
java 新浪短链接_新浪(t.cn)短网址链接生成api接口
最新的新浪(t.cn)短网址生成api接口,快速生成t.cn超短链接,接口可以正常调用,觉得不错可以收藏一下. 新浪短网址api接口: 使用说明: 将api接口地址中 "http://www ...
二维码生成api接口调用示例
二维码生成api接口,执行生成二维码,直接用标签调用接口地址即可.如今二维码已经得到极大的普及和流行,这不仅是因为二维码具有易识别.多终端支持的特点,更得利于其所含有的多种信息内容. 接口名称:二维码 ...
python生成api文档_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
使用sphinx快速为你python注释生成API文档
sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的 ...

python生成api文档_sphinx生成python文档

python生成api文档_sphinx生成python文档相关推荐

最新文章

热门文章