add doc for __init__.py

This commit is contained in:
yanyongyu
2020-08-18 17:24:49 +08:00
parent 76cfe34fa5
commit e523aa8d89
11 changed files with 10877 additions and 83 deletions

7
docs_build/README.rst Normal file
View File

@ -0,0 +1,7 @@
NoneBot Api Reference
=====================
:模块索引:
- `nonebot <nonebot.html>`_
- `nonebot.typing <typing.html>`_
- `nonebot.config <config.html>`_

View File

@ -1,68 +0,0 @@
---
sidebar: auto
---
nonebot api reference
===============
.. automodule:: nonebot
:members:
:undoc-members:
:show-inheritance:
`nonebot.matcher` 模块
----------------------
.. automodule:: nonebot.matcher
:members:
:undoc-members:
:show-inheritance:
`nonebot.plugin` 模块
---------------------
.. automodule:: nonebot.plugin
:members:
:undoc-members:
:show-inheritance:
`nonebot.rule` 模块
-------------------
.. automodule:: nonebot.rule
:members:
:undoc-members:
:show-inheritance:
`nonebot.event` 模块
--------------------
.. automodule:: nonebot.event
:members:
:undoc-members:
:show-inheritance:
`nonebot.exception` 模块
------------------------
.. automodule:: nonebot.exception
:members:
:undoc-members:
:show-inheritance:
`nonebot.log` 模块
------------------
.. automodule:: nonebot.log
:members:
:undoc-members:
:show-inheritance:
`nonebot.typing` 模块
---------------------
.. automodule:: nonebot.typing
:members:
:undoc-members:
:show-inheritance:

View File

@ -51,7 +51,7 @@ templates_path = ['_templates']
# Usually you set "language" from the command line for these cases.
language = 'zh'
master_doc = "api"
master_doc = "README"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.

7
docs_build/nonebot.rst Normal file
View File

@ -0,0 +1,7 @@
NoneBot 模块
===============
.. automodule:: nonebot
:members:
:undoc-members:
:show-inheritance: