diff --git a/.github/workflows/api_docs.yml b/.github/workflows/build_docs.yml similarity index 60% rename from .github/workflows/api_docs.yml rename to .github/workflows/build_docs.yml index f4ee792b..8f4b0dc2 100644 --- a/.github/workflows/api_docs.yml +++ b/.github/workflows/build_docs.yml @@ -1,7 +1,7 @@ name: Build API Doc on: - pull_request_target: + pull_request: types: [ opened, synchronize, reopened ] jobs: @@ -12,7 +12,6 @@ jobs: - uses: actions/checkout@v2 with: ref: ${{ github.event.pull_request.head.sha }} - token: ${{ secrets.GH_TOKEN }} - name: Set up Python uses: actions/setup-python@v2 @@ -32,11 +31,7 @@ jobs: - name: Copy Files run: cp -r ./build/markdown/* ./docs/api/ - - run: | - git config user.name nonebot - git config user.email nonebot@nonebot.dev - git add . - git diff-index --quiet HEAD || git commit -m ":memo: update api docs" - git remote -vv - git remote add target ${{github.event.pull_request.head.repo.clone_url}} - git push target HEAD:${{github.event.pull_request.head.ref}} + - uses: actions/upload-artifact@v2 + with: + name: docs + path: docs/ diff --git a/.github/workflows/upload_docs.yml b/.github/workflows/upload_docs.yml new file mode 100644 index 00000000..d20c3677 --- /dev/null +++ b/.github/workflows/upload_docs.yml @@ -0,0 +1,33 @@ +name: Upload API Doc + +on: + workflow_run: + workflows: ["Build API Doc"] + types: + - completed + +jobs: + upload: + runs-on: ubuntu-latest + if: ${{ github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' }} + steps: + - uses: actions/checkout@v2 + with: + ref: ${{ github.event.workflow_run.head_sha }} + token: ${{ secrets.GH_TOKEN }} + + - uses: dawidd6/action-download-artifact@v2 + with: + workflow: ${{ github.event.workflow_run.workflow_id }} + name: docs + path: docs/ + + - env: + REF: ${{ github.event.workflow_run.head_branch }} + run: | + git config user.name GitHub + git config user.email noreply@github.com + git add . + git diff-index --quiet HEAD || git commit -m ":memo: update api docs" + git remote add target "https://github.com/${{ github.event.workflow_run.head_repository.full_name }}.git" + git push target HEAD:$REF diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index e339e2ca..f7c87283 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -118,7 +118,21 @@ module.exports = context => ({ title: "进阶", collapsable: false, sidebar: "auto", - children: ["", "scheduler", "permission", "runtime-hook"] + children: [ + "", + "scheduler", + "permission", + "runtime-hook", + "export-and-require" + ] + }, + { + title: "发布", + collapsable: false, + sidebar: "auto", + children: [ + "publish-plugin" + ] } ], "/api/": [ diff --git a/docs/advanced/export-and-require.md b/docs/advanced/export-and-require.md new file mode 100644 index 00000000..832b0e75 --- /dev/null +++ b/docs/advanced/export-and-require.md @@ -0,0 +1 @@ +# 跨插件访问 diff --git a/docs/advanced/permission.md b/docs/advanced/permission.md index 30e20002..7190bcdd 100644 --- a/docs/advanced/permission.md +++ b/docs/advanced/permission.md @@ -1 +1 @@ -# 权限控制 \ No newline at end of file +# 权限控制 diff --git a/docs/advanced/publish-plugin.md b/docs/advanced/publish-plugin.md new file mode 100644 index 00000000..68e2e6f9 --- /dev/null +++ b/docs/advanced/publish-plugin.md @@ -0,0 +1 @@ +# 发布插件 diff --git a/docs/advanced/runtime-hook.md b/docs/advanced/runtime-hook.md index ed3968a4..58bca681 100644 --- a/docs/advanced/runtime-hook.md +++ b/docs/advanced/runtime-hook.md @@ -1 +1 @@ -# 运行时插槽 \ No newline at end of file +# 运行时插槽 diff --git a/docs/advanced/scheduler.md b/docs/advanced/scheduler.md index 99d906d3..53e6cedc 100644 --- a/docs/advanced/scheduler.md +++ b/docs/advanced/scheduler.md @@ -1 +1 @@ -# 定时任务 \ No newline at end of file +# 定时任务 diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 907630c9..2b54eae1 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -44,7 +44,8 @@ pip install nonebot2[scheduler] poetry add nonebot2[scheduler] ``` -[View On GitHub](https://github.com/agronholm/apscheduler) +[![apscheduler](https://img.shields.io/github/stars/agronholm/apscheduler?style=social)](https://github.com/agronholm/apscheduler) + ### NoneBot-Test @@ -57,7 +58,7 @@ pip install nonebot2[test] poetry add nonebot2[test] ``` -[View On GitHub](https://github.com/nonebot/nonebot-test) +[![nonebot-test](https://img.shields.io/github/stars/nonebot/nonebot-test?style=social)](https://github.com/nonebot/nonebot-test) ### CLI @@ -70,7 +71,7 @@ pip install nonebot2[cli] poetry add nonebot2[cli] ``` -[View On GitHub](https://github.com/yanyongyu/nb-cli) +[![nb-cli](https://img.shields.io/github/stars/nonebot/nb-cli?style=social)](https://github.com/yanyongyu/nb-cli) ### 我全都要 diff --git a/docs/guide/loading-a-plugin.md b/docs/guide/loading-a-plugin.md index b648b4b6..2a3016d5 100644 --- a/docs/guide/loading-a-plugin.md +++ b/docs/guide/loading-a-plugin.md @@ -52,12 +52,7 @@ if __name__ == "__main__": ::: :::danger 警告 -插件间不应该存在过多的耦合，如果确实需要导入某个插件内的数据，可以使用如下两种方法： - -1. (推荐) `from plugin_name import xxx` 而非 `from awesome_bot.plugins.plugin_name import xxx` -2. 在需要导入其他插件的文件中添加 `__package__ = "plugins"; from .plugin_name import xxx` (将共同的上层目录设定为父包后使用相对导入) - -具体可以参考：[nonebot/nonebot2#32](https://github.com/nonebot/nonebot2/issues/32) +插件间不应该存在过多的耦合，如果确实需要导入某个插件内的数据，可以参考 [进阶-跨插件访问](../advanced/export-and-require.md) ::: ## 加载单个插件 @@ -113,10 +108,6 @@ _sub_plugins |= nonebot.load_plugins( 插件将会被加载并存储于 `_sub_plugins` 中。 -:::tip 提示 -如果在父插件中需要定义事件响应器，应在**子插件被加载后**进行定义 -::: - ## 运行结果 尝试运行 `nb run` 或者 `python bot.py`，可以看到日志输出了类似如下内容：