Skip to content

Commit 2925334

Browse files
committed
Update docs
1 parent 4427578 commit 2925334

File tree

2 files changed

+29
-15
lines changed

2 files changed

+29
-15
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# line-bot-sdk-python
22

33
[![Build Status](https://travis-ci.org/line/line-bot-sdk-python.svg?branch=master)](https://travis-ci.org/line/line-bot-sdk-python)
4+
[![PyPI version](https://badge.fury.io/py/line-bot-sdk.svg)](https://badge.fury.io/py/line-bot-sdk)
5+
[![Documentation Status](https://readthedocs.org/projects/line-bot-sdk-python/badge/?version=latest)](http://line-bot-sdk-python.readthedocs.io/en/latest/?badge=latest)
46

57
SDK of the LINE Messaging API for Python.
68

@@ -82,7 +84,7 @@ You can override `timeout` value at each methods.
8284

8385
#### reply_message(self, reply_token, messages, timeout=None)
8486

85-
Respond to events from users, groups, and rooms.
87+
Respond to events from users, groups, and rooms.
8688
You can get a reply_token by a Webhook Event Object.
8789

8890
https://devdocs.line.me/en/#reply-message
@@ -364,7 +366,7 @@ parser = linebot.WebhookParser('YOUR_CHANNEL_SECRET')
364366

365367
#### parse(self, body, signature)
366368

367-
Parse webhook body and build Event Objects List.
369+
Parse webhook body and build Event Objects List.
368370
If signature does NOT match, raise InvalidSignatureError.
369371

370372
```python
@@ -411,7 +413,7 @@ When event is instance of MessageEvent and event.message is instance of TextMess
411413

412414
#### Set default handler method
413415

414-
You can set default handler method by using `default` decorator.
416+
You can set default handler method by using `default` decorator.
415417

416418
`default(self)`
417419

@@ -528,14 +530,16 @@ Sample echo-bot using [Flask](http://flask.pocoo.org/)
528530

529531
Sample bot using [Flask](http://flask.pocoo.org/)
530532

531-
## Sphinx (API document)
533+
## API document
532534

533535
```
534536
$ cd docs
535537
$ make html
536-
$ open _build/html/index.html
538+
$ open build/html/index.html
537539
```
538540

541+
OR [![Documentation Status](https://readthedocs.org/projects/line-bot-sdk-python/badge/?version=latest)](http://line-bot-sdk-python.readthedocs.io/en/latest/?badge=latest)
542+
539543
## Requirements
540544

541545
* python >= 2.7 or >= 3.3
@@ -550,7 +554,7 @@ $ pip install -r requirements-dev.txt
550554

551555
### Run tests
552556

553-
We test by using tox.
557+
We test by using tox.
554558
We test the following versions.
555559

556560
* 2.7

_README.rst

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
line-bot-sdk-python
22
===================
33

4+
|Build Status| |PyPI version| |Documentation Status|
5+
46
SDK of the LINE Messaging API for Python.
57

68
About LINE Messaging API
@@ -88,8 +90,8 @@ You can override ``timeout`` value at each methods.
8890
reply\_message(self, reply\_token, messages, timeout=None)
8991
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9092

91-
| Respond to events from users, groups, and rooms.
92-
| You can get a reply\_token by a Webhook Event Object.
93+
Respond to events from users, groups, and rooms. You can get a
94+
reply\_token by a Webhook Event Object.
9395

9496
https://devdocs.line.me/en/#reply-message
9597

@@ -391,8 +393,8 @@ WebhookParser
391393
parse(self, body, signature)
392394
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
393395

394-
| Parse webhook body and build Event Objects List.
395-
| If signature does NOT match, raise InvalidSignatureError.
396+
Parse webhook body and build Event Objects List. If signature does NOT
397+
match, raise InvalidSignatureError.
396398

397399
.. code:: python
398400
@@ -573,14 +575,16 @@ Sample echo-bot using `Flask <http://flask.pocoo.org/>`__
573575

574576
Sample bot using `Flask <http://flask.pocoo.org/>`__
575577

576-
Sphinx (API document)
577-
---------------------
578+
API document
579+
------------
578580

579581
::
580582

581583
$ cd docs
582584
$ make html
583-
$ open _build/html/index.html
585+
$ open build/html/index.html
586+
587+
OR |Documentation Status|
584588

585589
Requirements
586590
------------
@@ -599,8 +603,7 @@ First install for development.
599603
Run tests
600604
~~~~~~~~~
601605

602-
| We test by using tox.
603-
| We test the following versions.
606+
We test by using tox. We test the following versions.
604607

605608
- 2.7
606609
- 3.3
@@ -626,3 +629,10 @@ If you want to run a test against 2.7 version and against specific file:
626629
$ tox -e py27 -- tests/test_webhook.py
627630

628631
And more... TBD
632+
633+
.. |Build Status| image:: https://travis-ci.org/line/line-bot-sdk-python.svg?branch=master
634+
:target: https://travis-ci.org/line/line-bot-sdk-python
635+
.. |PyPI version| image:: https://badge.fury.io/py/line-bot-sdk.svg
636+
:target: https://badge.fury.io/py/line-bot-sdk
637+
.. |Documentation Status| image:: https://readthedocs.org/projects/line-bot-sdk-python/badge/?version=latest
638+
:target: http://line-bot-sdk-python.readthedocs.io/en/latest/?badge=latest

0 commit comments

Comments
 (0)