Docs: Bump nb-autodoc from 0.x to 1.0.0a5 (#1661)

This commit is contained in:
Anh71me 2023-02-02 16:10:22 +08:00 committed by GitHub
parent b534b3b03f
commit d2f000bb16
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 21 deletions

View File

@ -5,7 +5,10 @@ runs:
using: "composite" using: "composite"
steps: steps:
- run: | - 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/ cp -r ./build/nonebot/* ./website/docs/api/
yarn prettier yarn prettier
shell: bash shell: bash

View File

@ -47,7 +47,7 @@ class Event(abc.ABC, BaseModel):
通常你不需要修改这个方法只有当希望 NoneBot 隐藏该事件日志时可以抛出 `NoLogException` 异常 通常你不需要修改这个方法只有当希望 NoneBot 隐藏该事件日志时可以抛出 `NoLogException` 异常
异常: 异常:
NoLogException NoLogException:
""" """
return f"[{self.get_event_name()}]: {self.get_event_description()}" return f"[{self.get_event_name()}]: {self.get_event_description()}"

25
poetry.lock generated
View File

@ -1298,24 +1298,23 @@ files = [
[[package]] [[package]]
name = "nb-autodoc" name = "nb-autodoc"
version = "0.1.0" version = "1.0.0a5"
description = "API doc generator for NoneBot." description = "Powerful API Documentation Generator."
category = "dev" category = "dev"
optional = false optional = false
python-versions = ">=3.7" python-versions = ">=3.8"
files = [] files = []
develop = false develop = false
[package.dependencies] [package.dependencies]
attrs = ">=21.4,<22.0" click = ">=8.0.0,<9.0.0"
click = ">=8.0.3" typing-extensions = ">=4.0"
six = ">=1.6.1"
[package.source] [package.source]
type = "git" type = "git"
url = "https://github.com/nonebot/nb-autodoc.git" url = "https://github.com/nonebot/nb-autodoc.git"
reference = "HEAD" reference = "HEAD"
resolved_reference = "b9d69419dddf49c57f4cc47d5c2bcdbec673d32d" resolved_reference = "2e22353de35a8c46d4fc42067c06c6d51d56ec39"
[[package]] [[package]]
name = "nodeenv" 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 = ["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"] 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]] [[package]]
name = "sniffio" name = "sniffio"
version = "1.3.0" version = "1.3.0"