Cleanup documentation

docs/client.rst

@@ -26,117 +26,117 @@ WeChatClient
 
 .. module:: wechatpy.client.api
 
-WeChatUser 用户 API
+用户接口
 ----------------------
 
 .. autoclass:: WeChatUser
    :members:
 
-WeChatGroup 分组 API
+用户分组接口
 ----------------------
 
 .. autoclass:: WeChatGroup
    :members:
 
-WeChatMessage 主动消息 API
+主动消息接口
 -----------------------------
 
 .. autoclass:: WeChatMessage
    :members:
 
-WeChatMenu 自定义菜单 API
+自定义菜单接口
 ----------------------------
 
 .. autoclass:: WeChatMenu
    :members:
 
-WeChatMedia 媒体文件 API
+媒体文件接口
 ---------------------------
 
 .. autoclass:: WeChatMedia
    :members:
 
-WeChatQRCode 二维码 API
+二维码接口
 ---------------------------
 
 .. autoclass:: WeChatQRCode
    :members:
 
-WeChatMisc 工具类 API
+工具类接口
 --------------------------
 
 .. autoclass:: WeChatMisc
    :members:
 
-WeChatCard 卡券 API
+卡券接口
 -------------------------
 
 .. autoclass:: WeChatCard
    :members:
 
-WeChatMerchant 小店 API
+微信小店接口
 --------------------------
 
 .. autoclass:: WeChatMerchant
    :members:
 
 
-WeChatCustomService 客服消息 API
+客服消息接口
 ------------------------------------
 
 .. autoclass:: WeChatCustomService
    :members:
 
 
-WeChatDataCube 数据分析 API
+数据分析接口
 -------------------------------
 
 .. autoclass:: WeChatDataCube
    :members:
 
 
-WeChatJSAPI  JS-SDK API
+JS-SDK 接口
 ---------------------------
 
 .. autoclass:: WeChatJSAPI
    :members:
 
 
-WeChatMaterial 素材 API
+素材接口
 --------------------------
 
 .. autoclass:: WeChatMaterial
    :members:
 
 
-WeChatSemantic 语义理解 API
+语义理解接口
 -------------------------------
 
 .. autoclass:: WeChatSemantic
    :members:
 
 
-WeChatShakeAround 摇一摇周边 API
+摇一摇周边接口
 ---------------------------------
 
 .. autoclass:: WeChatShakeAround
    :members:
 
-WeChatDevice 设备功能 API
+设备功能接口
 ---------------------------
 
 .. autoclass:: WeChatDevice
    :members:
 
 
-WeChatTemplate 模板消息相关接口
+模板消息相关接口
 ---------------------------------
 
 .. autoclass:: WeChatTemplate
    :members:
 
 
-WeChatWiFi  微信连 Wi-Fi 接口
+微信连 Wi-Fi 接口
 ----------------------------------
 
 .. autoclass:: WeChatWiFi

docs/component.rst

@@ -14,19 +14,19 @@ WeChatComponent的基本使用方法::
     from wechatpy import WeChatComponent
     component = WeChatComponent('app_id', 'app_secret', 'component_token', 'encoding_aes_key')
 
-默认使用`wechatpy.session.memorystorage.MemoryStorage`缓存component的component_verify_ticket和授权码。通过component获取的公众号 client，也会使用component.session 作为缓存对象。
+默认使用 ``wechatpy.session.memorystorage.MemoryStorage`` 缓存component的component_verify_ticket和授权码。通过component获取的公众号 client，也会使用component.session 作为缓存对象。
 
-如果要使用外部的 session 对象，只要接口符合`wechatpy.session.SessionStorage`,都可以使用。只要增加`session=some_object`即可。
+如果要使用外部的 session 对象，只要接口符合 ``wechatpy.session.SessionStorage`` ,都可以使用。只要增加 ``session=some_object`` 即可。
 
-推荐使用外部的 session 对象，因为`wechatpy.session.memorystorage.MemoryStorage`暂不支持多线程操作。
+推荐使用外部的 session 对象，因为 ``wechatpy.session.memorystorage.MemoryStorage`` 暂不支持多线程操作。
 
 此后，可以调用component的其它方法完成公众号的授权、令牌刷新、获取或者设置公众号信息等操作。
 
 
-component_verify_ticket的处理
+component_verify_ticket 的处理
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-收到微信服务器发送的推送请求之后，只要调用`cache_component_verify_ticket(self, msg, signature, timestamp, nonce)`即可恰当地缓存component_verify_ticket。
+收到微信服务器发送的推送请求之后，只要调用 ``cache_component_verify_ticket(self, msg, signature, timestamp, nonce)`` 即可恰当地缓存component_verify_ticket。
 
 
 公众号 client 对象的获取
@@ -36,8 +36,8 @@ component_verify_ticket的处理
 
 当需要代公众号调用接口时，有两种方法:
 
-    - 将授权码传给component.get_client_by_authorization_code()，可以直接获取操作公众号 API 的对象。适用于刚刚获得授权的场景。
-    - 将公众号 appid传入`component.get_client_by_appid()`。适用于已经授权的场景。
+    - 将授权码传给 ``component.get_client_by_authorization_code()`` ，可以直接获取操作公众号 API 的对象。适用于刚刚获得授权的场景。
+    - 将公众号 appid传入 ``component.get_client_by_appid()`` 。适用于已经授权的场景。
 
 公众号的授权码和刷新码内部自动缓存。
 

docs/events.rst

@@ -1,8 +1,6 @@
 推送事件
 ==========
 
-目前 wechatpy 支持一下几种事件推送类型：`SubscribeEvent`, `UnsubscribeEvent`, `SubscribeScanEvent`, `ScanEvent`, `LocationEvent`, `ClickEvent`, `ViewEvent`, `MassSendJobFinishEvent`, `TemplateSendJobFinishEvent`, `ScanCodePushEvent`, `ScanCodeWaitMsgEvent`, `PicSysPhotoEvent`, `PicPhotoOrAlbumEvent`, `PicWeChatEvent` 和 `LocationSelectEvent`。
-
 事件本质上也是一种消息，故消息的公共属性在事件中也适用。
 
 公共属性
@@ -23,7 +21,7 @@ event       事件的类型
 
 .. module:: wechatpy.events
 
-SubscribeEvent 关注事件
+关注事件
 -----------------------------
 
 .. autoclass:: SubscribeEvent
@@ -37,7 +35,7 @@ name    value
 event   subscribe
 ======= =================================
 
-UnsubscribeEvent 取消关注事件
+取消关注事件
 -----------------------------------
 
 .. autoclass:: UnsubscribeEvent
@@ -51,7 +49,7 @@ name    value
 event   unsubscribe
 ======= =================================
 
-SubscribeScanEvent 未关注用户扫描带参数二维码事件
+未关注用户扫描带参数二维码事件
 --------------------------------------------------
 
 .. autoclass:: SubscribeScanEvent
@@ -68,7 +66,7 @@ scene_id  带参数二维码 scene_id，去除了前缀 `qrscene_`
 ticket    带参数二维码 ticket
 ========= ========================================
 
-ScanEvent 已关注用户扫描带参数二维码事件
+已关注用户扫描带参数二维码事件
 --------------------------------------------
 
 .. autoclass:: ScanEvent
@@ -84,7 +82,7 @@ scene_id  带参数二维码 scene_id
 ticket    带参数二维码 ticket
 ========= =================================
 
-LocationEvent 上报地理位置事件
+上报地理位置事件
 ----------------------------------
 
 .. autoclass:: LocationEvent
@@ -102,7 +100,7 @@ longitude   地理位置经度
 precision   地理位置精度
 =========== =================================
 
-ClickEvent 点击菜单拉取消息事件
+点击菜单拉取消息事件
 ----------------------------------
 
 .. autoclass:: ClickEvent
@@ -117,7 +115,7 @@ event   click
 key     自定义菜单 key 值
 ======= =================================
 
-ViewEvent 点击菜单跳转链接事件
+点击菜单跳转链接事件
 ----------------------------------
 
 .. autoclass:: ViewEvent
@@ -132,7 +130,7 @@ event   view
 url     跳转链接 url
 ======= =================================
 
-MassSendJobFinishEvent 群发消息发送任务完成事件
+群发消息发送任务完成事件
 -------------------------------------------------
 
 .. autoclass:: MassSendJobFinishEvent
@@ -151,7 +149,7 @@ sent_count    发送成功的粉丝数
 error_count   发送失败的粉丝数
 ============= =================================
 
-TemplateSendJobFinishEvent 模板消息发送任务完成事件
+模板消息发送任务完成事件
 ------------------------------------------------------
 
 .. autoclass:: TemplateSendJobFinishEvent
@@ -166,7 +164,7 @@ event   templatesendjobfinish
 status  模板消息发送状态
 ======= =================================
 
-ScanCodePushEvent 扫码推事件
+扫码推事件
 --------------------------------
 
 .. autoclass:: ScanCodePushEvent
@@ -183,7 +181,7 @@ scan_type   扫描类型
 scan_result 扫描结果
 =========== =================================
 
-ScanCodeWaitMsgEvent 扫码推事件且弹出“消息接收中”提示框
+扫码推事件且弹出“消息接收中”提示框
 -------------------------------------------------------
 
 .. autoclass:: ScanCodeWaitMsgEvent
@@ -200,7 +198,7 @@ scan_type   扫描类型
 scan_result 扫描结果
 =========== =================================
 
-PicSysPhotoEvent 弹出系统拍照发图事件
+弹出系统拍照发图事件
 -----------------------------------------
 
 .. autoclass:: PicSysPhotoEvent
@@ -217,7 +215,7 @@ count       发送的图片数量
 pictures    图片列表
 =========== =================================
 
-PicPhotoOrAlbumEvent 弹出拍照或者相册发图事件
+弹出拍照或者相册发图事件
 ------------------------------------------------
 
 .. autoclass:: PicPhotoOrAlbumEvent
@@ -234,7 +232,7 @@ count       发送的图片数量
 pictures    图片列表
 =========== =================================
 
-PicWeChatEvent 弹出微信相册发图器事件
+弹出微信相册发图器事件
 ---------------------------------------
 
 .. autoclass:: PicWeChatEvent
@@ -251,7 +249,7 @@ count       发送的图片数量
 pictures    图片列表
 =========== =================================
 
-LocationSelectEvent 弹出地理位置选择器事件
+弹出地理位置选择器事件
 --------------------------------------------
 
 .. autoclass:: LocationSelectEvent
@@ -276,7 +274,7 @@ poiname     朋友圈 POI 的名字，可能为空
 微信认证事件推送
 ----------------
 
-QualificationVerifySuccessEvent 资质认证成功事件
+资质认证成功事件
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: QualificationVerifySuccessEvent
@@ -291,7 +289,7 @@ event        qualification_verify_success
 expired_time 有效期，将于该时间戳认证过期
 ============ ============================================
 
-QualificationVerifyFailEvent 资质认证失败事件
+资质认证失败事件
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: QualificationVerifyFailEvent
@@ -307,7 +305,7 @@ fail_time    失败发生时间
 fail_reason  认证失败的原因
 ============ ============================================
 
-NamingVerifySuccessEvent 名称认证成功
+名称认证成功
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: NamingVerifySuccessEvent
@@ -322,7 +320,7 @@ event        naming_verify_success
 expired_time 有效期，将于该时间戳认证过期
 ============ ============================================
 
-NamingVerifyFailEvent 名称认证失败
+名称认证失败
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: NamingVerifyFailEvent
@@ -338,7 +336,7 @@ fail_time    失败发生时间
 fail_reason  认证失败的原因
 ============ ============================================
 
-AnnualRenewEvent 年审通知
+年审通知
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: AnnualRenewEvent
@@ -353,7 +351,7 @@ event        annual_renew
 expired_time 有效期，将于该时间戳认证过期，需尽快年审
 ============ ============================================
 
-VerifyExpiredEvent 认证过期失效通知
+认证过期失效通知
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: VerifyExpiredEvent

docs/index.rst

@@ -8,13 +8,14 @@ wechatpy 使用文档
 
 wechatpy 是一个微信 (WeChat) 公众平台的第三方 Python SDK, 实现了普通公众平台和企业号公众平台的解析消息、生成回复和主动调用等 API。
 
-安装与升级
+快速入门
 -------------
 
 .. toctree::
    :maxdepth: 2
 
    install
+   quickstart
 
 微信公众平台接口
 -------------------