Merge pull request #14 from RicardoRyn/dev

Dev

Author: RicardoRyn

.github/workflows/dependency_review.yml

@@ -7,10 +7,10 @@
 #
 # Source repository: https://github.com/actions/dependency-review-action
 # Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
-name: 'Dependency review'
+name: "Dependency review"
 on:
   pull_request:
-    branches: [ "main", "dev" ]
+    branches: ["main", "dev"]
 
 # If using a dependency submission action in this workflow this permission will need to be set to:
 #
@@ -27,9 +27,9 @@ jobs:
   dependency-review:
     runs-on: ubuntu-latest
     steps:
-      - name: 'Checkout repository'
+      - name: "Checkout repository"
         uses: actions/checkout@v4
-      - name: 'Dependency Review'
+      - name: "Dependency Review"
         uses: actions/dependency-review-action@v4
         # Commonly enabled options, see https://github.com/actions/dependency-review-action#configuration-options for all available options.
         with:

.github/workflows/python_publish.yml

@@ -28,9 +28,6 @@ jobs:
 
       - name: Build release distributions
         run: |
-          # NOTE: put your own distribution build steps here.
-          # python -m pip install build
-          # python -m build
           pip install uv
           uv build
 

.github/workflows/release.yml

@@ -19,4 +19,4 @@ jobs:
         with:
           token: ${{ secrets.RELEASE_PLEASE_ACCESS_TOKEN }}
           config-file: release-please-config.json
-          manifest-file: .release-please-manifest.json
+          manifest-file: .release-please-manifest.json

.github/workflows/sync_to_gitee.yml

@@ -1,6 +1,6 @@
 name: Sync To Gitee
 
-on: [ push, delete, create ]
+on: [push, delete, create]
 
 jobs:
   build:

.github/workflows/website_deploy.yml

@@ -1,4 +1,4 @@
-name: Website Deploy 
+name: Website Deploy
 on:
   push:
     branches:
@@ -19,14 +19,14 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
       - uses: actions/cache@v4
         with:
           key: mkdocs-material-${{ env.cache_id }}
-          path: .cache 
+          path: .cache
           restore-keys: |
             mkdocs-material-
-      
+
       - name: Check if CHANGELOG.md has changed
         id: changelog_check
         run: |
@@ -69,7 +69,7 @@ jobs:
           summary="${{ steps.inference.outputs.response }}"
           # 使用 printf 保证换行缩进和变量替换都准确
           mkdir -p overrides
-          printf '{%% extends "base.html" %%}\n\n{%% block announce %%}\n  <strong>📢 %s 查看<a href="/plotfig/changelog">更新日志</a>。</strong>\n{%% endblock %%}\n' "$summary" > overrides/main.html
+          printf '{%% extends "base.html" %%}\n\n{%% block announce %%}\n  <strong>📢 %s <a href="/plotfig/changelog">点击查看详情</a></strong>\n{%% endblock %%}\n' "$summary" > overrides/main.html
 
       - name: Copy CHANGELOG.md to docs/
         run: cp CHANGELOG.md docs/changelog.md

README.md

@@ -47,31 +47,17 @@ cd plotfig
 pip install .
 ```
 
-## 贡献指南
-
-如果您希望参与 `plotfig` 的开发，或者想体验尚未正式发布的新功能和最新修复的 bug，可以选择以开发模式安装项目。
-
-这种“可编辑模式（editable mode）”安装方式允许您对本地源码的修改立即生效，非常适合开发、调试和贡献代码。
-
-推荐先 Fork 仓库，然后克隆您自己的 Fork：
-
-```bash
-git clone -b dev https://github.com/<your-username>/plotfig.git
-cd plotfig
-pip install -e .
-```
-
 ## 依赖要求
 
 `plotfig` 依赖若干核心库，这些依赖将在安装过程中自动处理：
 
-- [matplotlib](https://matplotlib.org/) ≥ 3.10.1  
-- [mne-connectivity](https://mne.tools/mne-connectivity/stable/index.html) ≥ 0.7.0  
-- [nibabel](https://nipy.org/nibabel/) ≥ 5.3.2  
-- [numpy](https://numpy.org/) ≥ 2.2.4  
-- [pandas](https://pandas.pydata.org/) ≥ 2.2.3  
-- [plotly](https://plotly.com/) ≥ 6.0.1  
-- [scipy](https://scipy.org/) ≥ 1.15.2  
+- [matplotlib](https://matplotlib.org/) ≥ 3.10.
+- [mne-connectivity](https://mne.tools/mne-connectivity/stable/index.html) ≥ 0.7.
+- [nibabel](https://nipy.org/nibabel/) ≥ 5.3.
+- [numpy](https://numpy.org/) ≥ 2.2.4
+- [pandas](https://pandas.pydata.org/) ≥ 2.2.
+- [plotly](https://plotly.com/) ≥ 6.0.1
+- [scipy](https://scipy.org/) ≥ 1.15.
 - [surfplot](https://github.com/danjgale/surfplot) 需使用其 GitHub 仓库中的最新版，而非 PyPI 上的版本，因后者尚未包含所需功能。
 
 > ⚠️ **指定 `surfplot` 版本**
@@ -82,7 +68,7 @@ pip install -e .
 > # 卸载旧版本
 > pip uninstall surfplot
 >
-> # 克隆源码仓库并安装
+> # 克隆源码并安装
 > git clone --depth 1 https://github.com/danjgale/surfplot.git
 > cd surfplot
 > pip install .
@@ -91,3 +77,23 @@ pip install -e .
 > cd ..
 > rm -rf surfplot
 > ```
+
+## 贡献指南
+
+如果您希望参与 `plotfig` 的开发，或者想体验尚未正式发布的新功能和最新修复的 bug，可以选择以开发模式安装项目。
+
+这种“可编辑模式（editable mode）”安装方式允许您对本地源码的修改立即生效，非常适合开发、调试和贡献代码。
+
+推荐先 Fork 仓库，然后克隆您自己的 Fork：
+
+```bash
+git clone -b dev https://github.com/<your-username>/plotfig.git
+cd plotfig
+pip install -e .
+```
+
+**欢迎提交 Issue 或 PR！**
+
+无论是 Bug 报告、功能建议，还是文档改进，都非常欢迎你的参与。
+如果你在使用过程中遇到了问题，或者有更好的想法，欢迎在 [Issue](https://github.com/RicardoRyn/plotfig/issues) 中提出。
+也可以直接提交 [PR](https://github.com/RicardoRyn/plotfig/pulls)，一起变得更强 🙌！

docs/index.md

@@ -20,8 +20,6 @@
 
 ## 文档与示例
 
-`plotfig` 提供了网页文档和使用示例。具体参见[使用教程](https://ricardoryn.github.io/plotfig/)。
-
 `plotfig` API 设计简洁，参数灵活，适合科研人员和数据分析师快速集成到自己的数据分析流程中。
 其模块化架构便于后续功能扩展和自定义开发。
 结合 `matplotlib` 支持矢量图或高分辨率位图和交互式 HTML 输出，适合论文发表和学术展示。

docs/installation.md

@@ -1,8 +1,9 @@
+# 安装
+
 ## 普通安装
 
 `plotfig` 支持通过 `pip` 或源码安装，要求 Python 3.11 及以上版本。
 
-
 **使用 pip 安装 <small>(推荐)</small>**
 
 ```bash
@@ -17,31 +18,17 @@ cd plotfig
 pip install .
 ```
 
-## 贡献指南
-
-如果您希望参与 `plotfig` 的开发，或者想体验尚未正式发布的新功能和最新修复的 bug，可以选择以开发模式安装项目。
-
-这种“可编辑模式（editable mode）”安装方式允许您对本地源码的修改立即生效，非常适合开发、调试和贡献代码。
-
-推荐先 Fork 仓库，然后克隆您自己的 Fork：
-
-```bash
-git clone -b dev https://github.com/<your-username>/plotfig.git
-cd plotfig
-pip install -e .
-```
-
 ## 依赖要求
 
 `plotfig` 依赖若干核心库，这些依赖将在安装过程中自动处理：
 
-- [matplotlib](https://matplotlib.org/) ≥ 3.10.1  
-- [mne-connectivity](https://mne.tools/mne-connectivity/stable/index.html) ≥ 0.7.0  
-- [nibabel](https://nipy.org/nibabel/) ≥ 5.3.2  
-- [numpy](https://numpy.org/) ≥ 2.2.4  
-- [pandas](https://pandas.pydata.org/) ≥ 2.2.3  
-- [plotly](https://plotly.com/) ≥ 6.0.1  
-- [scipy](https://scipy.org/) ≥ 1.15.2  
+- [matplotlib](https://matplotlib.org/) ≥ 3.10.1
+- [mne-connectivity](https://mne.tools/mne-connectivity/stable/index.html) ≥ 0.7.0
+- [nibabel](https://nipy.org/nibabel/) ≥ 5.3.2
+- [numpy](https://numpy.org/) ≥ 2.2.4
+- [pandas](https://pandas.pydata.org/) ≥ 2.2.3
+- [plotly](https://plotly.com/) ≥ 6.0.1
+- [scipy](https://scipy.org/) ≥ 1.15.2
 - [surfplot](https://github.com/danjgale/surfplot) 需使用其 GitHub 仓库中的最新版，而非 PyPI 上的版本，因后者尚未包含所需功能。
 
 !!! warning "指定 `surfplot` 版本"
@@ -52,7 +39,7 @@ pip install -e .
     # 卸载旧版本
     pip uninstall surfplot
 
-    # 克隆源码仓库并安装
+    # 克隆源码并安装
     git clone --depth 1 https://github.com/danjgale/surfplot.git
     cd surfplot
     pip install .
@@ -61,3 +48,23 @@ pip install -e .
     cd ..
     rm -rf surfplot
     ```
+
+## 贡献指南
+
+如果您希望参与 `plotfig` 的开发，或者想体验尚未正式发布的新功能和最新修复的 bug，可以选择以开发模式安装项目。
+
+这种“可编辑模式（editable mode）”安装方式允许您对本地源码的修改立即生效，非常适合开发、调试和贡献代码。
+
+推荐先 Fork 仓库，然后克隆您自己的 Fork：
+
+```bash
+git clone -b dev https://github.com/<your-username>/plotfig.git
+cd plotfig
+pip install -e .
+```
+
+**欢迎提交 Issue 或 PR！**
+
+无论是 Bug 报告、功能建议，还是文档改进，都非常欢迎你的参与。
+如果你在使用过程中遇到了问题，或者有更好的想法，欢迎在 [Issue](https://github.com/RicardoRyn/plotfig/issues) 中提出。
+也可以直接提交 [PR](https://github.com/RicardoRyn/plotfig/pulls)，一起变得更强 🙌！

docs/usage/brain_surface_deprecated.md

@@ -65,6 +65,16 @@ data = {"lh_V1": 1, "rh_MT": 1.5}
 ax = plot_human_brain_figure(data)
 ```
 
+    C:\Users\RicardoRyn\AppData\Local\Temp\ipykernel_32020\3935563387.py:5: DeprecationWarning: plot_human_brain_figure 即将弃用，请使用 plot_brain_surface_figure 替代。未来版本将移除本函数。
+      ax = plot_human_brain_figure(data)
+    
+
+
+    
+![png](brain_surface_deprecated_files/brain_surface_deprecated_7_1.png)
+    
+
+
 
 ```python
 import matplotlib.pyplot as plt