更新Sphinx配置，添加myst_nb扩展及其版本要求 (#242)

QG-phy · web-flow · commit 0a88764a132f · 2025-05-05T04:16:13.000+08:00
* 更新Sphinx配置，添加myst_nb扩展及其版本要求

* Refactor code structure for improved readability and maintainability

* 更新Sphinx配置，移除myst_parser并确保myst-nb包含所需功能

* 更新依赖项，移除myst-parser并添加linkify-it-py和myst-nb
diff --git a/.github/workflows/add_pages_doc.yml b/.github/workflows/add_pages_doc.yml
@@ -18,7 +18,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install sphinx sphinx_book_theme myst-parser
+        pip install sphinx sphinx_book_theme linkify-it-py
+        pip install myst-nb jupyter
         # 安装deepmodeling_sphinx
         if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi
     - name: Build docs
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,7 +31,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-        'myst_parser',
+        'myst_nb',
         'deepmodeling_sphinx',
 ]
 myst_enable_extensions = [
diff --git a/docs/quick_start/hands_on/index.rst b/docs/quick_start/hands_on/index.rst
@@ -5,3 +5,4 @@ A quick Example
 .. toctree::
    sktb_hands_on
    e3tb_hands_on
+   tutorial1_base_sk
diff --git a/docs/quick_start/hands_on/tutorial1_base_sk.ipynb b/docs/quick_start/hands_on/tutorial1_base_sk.ipynb
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,7 @@
 urllib3 == 1.26.15
-myst_parser[linkify]
+# myst_parser[linkify]  # 注释掉，因为myst-nb已包含myst_parser功能
+myst-nb[linkify]
 sphinx_rtd_theme
 sphinx-book-theme
 deepmodeling_sphinx >= 0.1.2
+jupyter  # 添加jupyter支持

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom`
`32`	`32`	`# ones.`
`33`	`33`	`extensions = [`
`34`		`- 'myst_parser',`
	`34`	`+ 'myst_nb',`
`35`	`35`	`'deepmodeling_sphinx',`
`36`	`36`	`]`
`37`	`37`	`myst_enable_extensions = [`