Skip to content

Commit

Permalink
update: doc
Browse files Browse the repository at this point in the history
  • Loading branch information
williamfzc committed Mar 9, 2019
1 parent d8ce2bd commit 06ecca6
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[![Maintainability](https://api.codeclimate.com/v1/badges/5f6647a3121aa7d278ab/maintainability)](https://codeclimate.com/github/williamfzc/pyatool/maintainability)
[![PyPI version](https://badge.fury.io/py/pyatool.svg)](https://badge.fury.io/py/pyatool)
[![Downloads](https://pepy.tech/badge/pyatool)](https://pepy.tech/project/pyatool)
[![Documentation Status](https://readthedocs.org/projects/pyatool/badge/?version=latest)](https://pyatool.readthedocs.io/en/latest/?badge=latest)

> python android toolkit 🔨
Expand All @@ -25,7 +26,7 @@ package_list = device.std.show_package(toolkit=device)
print(package_list)
```

- 完整API参见[extras.py](pyatool/extras.py)
- 完整API参见[官方文档](https://pyatool.readthedocs.io/en/latest/)
- 更多使用例子参见[demo.py](demo.py)

## 安装
Expand Down
1 change: 1 addition & 0 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
[![Maintainability](https://api.codeclimate.com/v1/badges/5f6647a3121aa7d278ab/maintainability)](https://codeclimate.com/github/williamfzc/pyatool/maintainability)
[![PyPI version](https://badge.fury.io/py/pyatool.svg)](https://badge.fury.io/py/pyatool)
[![Downloads](https://pepy.tech/badge/pyatool)](https://pepy.tech/project/pyatool)
[![Documentation Status](https://readthedocs.org/projects/pyatool/badge/?version=latest)](https://pyatool.readthedocs.io/en/latest/?badge=latest)

> python android toolkit 🔨
Expand Down
18 changes: 18 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,24 @@ Welcome to pyatool's documentation!
:maxdepth: 2
:caption: Contents:

Usage
=====

使用方法如下 ::

from pyatool import PYAToolkit

device = PYAToolkit('123456F')

# 直接调用
package_list = device.show_package()
# 通过标准库(有自动补全)
package_list = device.std.show_package(toolkit=device)

print(package_list)

要调用其他的API,将 `show_package` 替换成API名称即可!

API
===
.. automodule:: pyatool.extras
Expand Down

0 comments on commit 06ecca6

Please sign in to comment.