📝更新文档

luren-dc · Oct 12, 2023 · 9b5487e · 9b5487e
1 parent bacf1bd
commit 9b5487e
Show file tree

Hide file tree

Showing 9 changed files with 144 additions and 78 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -21,5 +21,8 @@ jobs:
           path: .cache
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material pygments mkdocstrings
-      - run: mkdocs gh-deploy --force
+      - uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: 1.6.1
+      - run: poetry install --only docs
+      - run: poetry run mkdocs gh-deploy --force
diff --git a/docs/api.md b/docs/api.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -21,17 +21,27 @@ theme:
       toggle:
         icon: material/brightness-4
         name: Switch to system preference
+  icon:
+    repo: fontawesome/brands/github
   features:
     - search.suggest
     - search.highlight
     - content.tabs.link
     - navigation.indexes
     - content.tooltips
+    - navigation.top
     - navigation.path
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.tracking
     - content.code.annotate
     - content.code.copy
     - content.code.select
 
+repo_name: luren-dc/QQMusicApi
+repo_url: https://github.com/luren-dc/QQMusicApi
+
 markdown_extensions:
   # Python Markdown
   - abbr
@@ -69,4 +79,17 @@ markdown_extensions:
 
 plugins:
   - search
-  - mkdocstrings
+  - mkdocstrings:
+      handlers:
+        python:
+          setup_commands:
+            - import sys
+            - sys.path.insert(0, ".")
+          import:
+            # latest instead of stable
+            - https://installer.readthedocs.io/en/latest/objects.inv
+            - https://docs.python.org/3/objects.inv
+  - autorefs
+  - git-revision-date-localized:
+      enable_creation_date: true
+  - git-authors
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -15,8 +15,11 @@ aiohttp = "^3.8.5"
 [tool.poetry.group.docs.dependencies]
 mkdocs-material = "^9.4.4"
 mkdocs = "^1.5.3"
-mkdocstrings = "^0.23.0"
+mkdocstrings = {extras = ["python"], version = "^0.23.0"}
 pygments = "^2.16.1"
+mkdocs-autorefs = "^0.5.0"
+mkdocs-git-authors-plugin = "^0.7.2"
+mkdocs-git-revision-date-localized-plugin = "^1.2.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.0"

diff --git a/qqmusicapi/api/README.md b/qqmusicapi/api/README.md
diff --git a/qqmusicapi/api/login.py b/qqmusicapi/api/login.py
@@ -84,7 +84,7 @@ async def authorize(self, code: Optional[int] = None) -> bool:
         验证。
 
         Args:
-            code: 验证码
+            code: 验证码。仅在使用手机号登录时传递。
 
         Returns:
             bool: 是否登录成功
@@ -425,7 +425,7 @@ def request(login_type: int = 0, phone: Optional[int] = None) -> Login:
         创建登录对象。
 
         Args:
-            login_type : 登录类型。0 表示 QQ 登录，1 表示微信登录，2 表示手机号登录。默认为 0。
+            login_type : 登录类型。0=QQ 登录，1=微信登录，2=手机号登录。
             phone: 手机号(可选)。
 
         Returns:

diff --git a/qqmusicapi/api/song.py b/qqmusicapi/api/song.py
@@ -12,17 +12,12 @@
 
 
 class SongApi:
-    """歌曲Api"""
+    """歌曲API"""
 
     parent: ClassVar[QQMusic]
 
     """
-    文件类型与其对应的前缀和后缀
-    试听 需要拼接歌曲信息中的vs
-    "audition": {
-        "s": "RS02",
-        "e": ".mp3",
-    }
+    文件类
     """
     FILE_TYPE = {
         "AI00": ".flac",
@@ -42,6 +37,7 @@ class SongApi:
         "O400": ".ogg",
         "C200": ".m4a",
         "C100": ".m4a",
+        "RS02": ".mp3",
     }
 
     @staticmethod

diff --git a/tests/test_login.py b/tests/test_login.py
@@ -38,7 +38,8 @@ async def login(type: int):
             elif state == 0:
                 break
             await asyncio.sleep(1)
-        return await login.authorize()
+        await login.authorize()
+        print(login.token)
 
 
 @pytest.mark.asyncio