Skip to content

Commit 1dac43a

Browse files
authored
Merge branch 'hect0x7:master' into master
2 parents b40f80b + 397d4ab commit 1dac43a

File tree

15 files changed

+98
-12
lines changed

15 files changed

+98
-12
lines changed

.github/workflows/test_api.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
test: # This code is based on https://github.com/gaogaotiantian/viztracer/blob/master/.github/workflows/python-package.yml
1717
strategy:
1818
matrix:
19-
python-version: ['3.7', '3.8', '3.11', '3.12']
19+
python-version: ['3.9', '3.10', '3.11', '3.13']
2020
os: [ ubuntu-latest ]
2121
runs-on: ${{ matrix.os }}
2222
timeout-minutes: 5

assets/docs/mkdocs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ plugins:
4040
python:
4141
paths: [ '../../src/' ]
4242
options:
43+
summary:
44+
functions: true
45+
preload_modules:
46+
- common
4347
docstring_style: sphinx
4448

4549

assets/docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ mkdocs
22
mkdocstrings[python]
33
markdown-include
44
mkdocs-material
5+
commonX

assets/docs/sources/api/client.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# client
22

33
::: jmcomic.jm_client_impl
4-
4+
options:
5+
members:
6+
- JmHtmlClient
7+
- JmApiClient
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# command-line
2+
3+
::: jmcomic.cl
4+
options:
5+
members:
6+
- JmcomicUI

assets/docs/sources/api/config.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# config
22

3-
::: jmcomic.jm_config.JmModuleConfig
3+
::: jmcomic.jm_config
4+
options:
5+
members:
6+
- JmMagicConstants
7+
- JmModuleConfig
8+
- default_jm_logging
9+
Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# download
22

33
::: jmcomic.api
4-
4+
options:
5+
members:
6+
- download_album
7+
- download_photo
8+
- create_option
9+
- create_option_by_env
10+
- create_option_by_file
11+
- create_option_by_str

assets/docs/sources/api/entity.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# entity
22

3-
::: jmcomic.jm_entity
3+
::: jmcomic.jm_entity
4+
options:
5+
inherited_members: true
6+
members:
7+
- JmAlbumDetail
8+
- JmPhotoDetail
9+
- JmImageDetail
10+
- JmPageContent
11+
- JmSearchPage

assets/docs/sources/api/option.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# option
22

3-
::: jmcomic.jm_option.JmOption
3+
::: jmcomic.jm_option
4+
options:
5+
members:
6+
- DirRule
7+
- JmOption

assets/docs/sources/api/plugin.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
# plugin
22

3-
::: jmcomic.jm_plugin
3+
::: jmcomic.jm_plugin
4+
options:
5+
filters:
6+
- Plugin$

0 commit comments

Comments
 (0)