From d2f000bb16f2fbba4a7e80b00f9c3333d32f2c81 Mon Sep 17 00:00:00 2001 From: Anh71me Date: Thu, 2 Feb 2023 16:10:22 +0800 Subject: [PATCH] Docs: Bump nb-autodoc from 0.x to 1.0.0a5 (#1661) --- .github/actions/build-api-doc/action.yml | 5 ++++- nonebot/internal/adapter/event.py | 2 +- poetry.lock | 25 ++++++------------------ 3 files changed, 11 insertions(+), 21 deletions(-) diff --git a/.github/actions/build-api-doc/action.yml b/.github/actions/build-api-doc/action.yml index f86a373f..3d6a7cd3 100644 --- a/.github/actions/build-api-doc/action.yml +++ b/.github/actions/build-api-doc/action.yml @@ -5,7 +5,10 @@ runs: using: "composite" steps: - run: | - poetry run nb-autodoc nonebot + poetry run nb-autodoc nonebot \ + -s nonebot.plugins \ + -u nonebot.internal \ + -u nonebot.internal.* cp -r ./build/nonebot/* ./website/docs/api/ yarn prettier shell: bash diff --git a/nonebot/internal/adapter/event.py b/nonebot/internal/adapter/event.py index f839e88a..e5a1aa6a 100644 --- a/nonebot/internal/adapter/event.py +++ b/nonebot/internal/adapter/event.py @@ -47,7 +47,7 @@ class Event(abc.ABC, BaseModel): 通常你不需要修改这个方法,只有当希望 NoneBot 隐藏该事件日志时,可以抛出 `NoLogException` 异常。 异常: - NoLogException + NoLogException: """ return f"[{self.get_event_name()}]: {self.get_event_description()}" diff --git a/poetry.lock b/poetry.lock index 128a6271..25e8c04b 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1298,24 +1298,23 @@ files = [ [[package]] name = "nb-autodoc" -version = "0.1.0" -description = "API doc generator for NoneBot." +version = "1.0.0a5" +description = "Powerful API Documentation Generator." category = "dev" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [] develop = false [package.dependencies] -attrs = ">=21.4,<22.0" -click = ">=8.0.3" -six = ">=1.6.1" +click = ">=8.0.0,<9.0.0" +typing-extensions = ">=4.0" [package.source] type = "git" url = "https://github.com/nonebot/nb-autodoc.git" reference = "HEAD" -resolved_reference = "b9d69419dddf49c57f4cc47d5c2bcdbec673d32d" +resolved_reference = "2e22353de35a8c46d4fc42067c06c6d51d56ec39" [[package]] name = "nodeenv" @@ -1884,18 +1883,6 @@ docs = ["furo", "jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "pygments-g testing = ["build[virtualenv]", "filelock (>=3.4.0)", "flake8 (<5)", "flake8-2020", "ini2toml[lite] (>=0.9)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "pip (>=19.1)", "pip-run (>=8.8)", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-flake8", "pytest-mypy (>=0.9.1)", "pytest-perf", "pytest-timeout", "pytest-xdist", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"] testing-integration = ["build[virtualenv]", "filelock (>=3.4.0)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "pytest", "pytest-enabler", "pytest-xdist", "tomli", "virtualenv (>=13.0.0)", "wheel"] -[[package]] -name = "six" -version = "1.16.0" -description = "Python 2 and 3 compatibility utilities" -category = "dev" -optional = false -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" -files = [ - {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"}, - {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"}, -] - [[package]] name = "sniffio" version = "1.3.0"