0.5.0 - add dependency explanations.

cainmagi · Nov 29, 2024 · 8c295dc · 8c295dc
1 parent 0917151
commit 8c295dc
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 13 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -9,6 +9,7 @@
 #### :wrench: Fix
 
 1. Fix: Correct the version numbers of the legacy document `v0.4.x`.
+2. Fix: Add the missing explanations for the new optional dependency collection `example`.
 
 ### 0.5.0 @ 11/27/2024
 

diff --git a/docs/tutorial/install.mdx b/docs/tutorial/install.mdx
@@ -11,7 +11,8 @@ import octInfo16 from "@iconify-icons/octicon/info-16";
 import octLogoGist16 from "@iconify-icons/octicon/logo-gist-16";
 import IconExternalLink from "@theme/Icon/ExternalLink";
 
-import {repoURL} from "@site/src/envs/variables";
+import IconLink from "@site/src/components/IconLink";
+import {repoURL, rootURL} from "@site/src/envs/variables";
 
 # Install the Python package
 
@@ -29,10 +30,11 @@ Specify the optional dependencies to enable more features:
 pip install dash-json-grid[option1,option2...]
 ```
 
-| Option | <center>Supports</center>                                                                                               |
-| :----: | :---------------------------------------------------------------------------------------------------------------------- |
-| `test` | Install the dependencies related to `pytest`. These dependencies are not used by the package but used by the unittests. |
-| `dev`  | Install the developer's dependencies. These dependencies may be used for building the package.                          |
+|  Option   | <center>Supports</center>                                                                                                                                                         |
+| :-------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|  `test`   | Install the dependencies related to `pytest`. These dependencies are not used by the package but used by the unittests.                                                           |
+| `example` | Install the extra depedencies for running the demos in the <IconLink text="examples" href={rootURL("examples")}/>. These packages are used by demos but not used by this project. |
+|   `dev`   | Install the developer's dependencies. These dependencies may be used for building the package.                                                                                    |
 
 ## Install the GitHub version
 
@@ -120,6 +122,6 @@ pass the tests, please
 [link-git]: https://git-scm.com/downloads
 [link-nodejs]: https://nodejs.org/en/download/package-manager
 [link-yarn]: https://yarnpkg.com/getting-started/install
-[link-chrome]:https://www.google.com/chrome/dr/download
-[link-chromium]:https://www.chromium.org/getting-involved/download-chromium
-[link-dash-duo]:https://dash.plotly.com/testing
+[link-chrome]: https://www.google.com/chrome/dr/download
+[link-chromium]: https://www.chromium.org/getting-involved/download-chromium
+[link-dash-duo]: https://dash.plotly.com/testing
diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/tutorial/install.mdx b/i18n/zh-cn/docusaurus-plugin-content-docs/current/tutorial/install.mdx
@@ -11,7 +11,8 @@ import octInfo16 from "@iconify-icons/octicon/info-16";
 import octLogoGist16 from "@iconify-icons/octicon/logo-gist-16";
 import IconExternalLink from "@theme/Icon/ExternalLink";
 
-import {repoURL} from "@site/src/envs/variables";
+import IconLink from "@site/src/components/IconLink";
+import {repoURL, rootURL} from "@site/src/envs/variables";
 
 # 安装本项目的 Python 包
 
@@ -29,10 +30,11 @@ pip install dash-json-grid
 pip install dash-json-grid[option1,option2...]
 ```
 
-| Option | <center>Supports</center>                                                                                              |
-| :----: | :--------------------------------------------------------------------------------------------------------------------- |
-| `test` | 安装用于进行[`pytest`<IconExternalLink/>][link-pytest]测试的依赖项。这些依赖项只用于单元测试，不用于提供任何实际功能。 |
-| `dev`  | 安装开发者依赖项。构建模块包的时候才有可能需要这些依赖项。                                                             |
+|  Option   | <center>Supports</center>                                                                                                               |
+| :-------: | :-------------------------------------------------------------------------------------------------------------------------------------- |
+|  `test`   | 安装用于进行[`pytest`<IconExternalLink/>][link-pytest]测试的依赖项。这些依赖项只用于单元测试，不用于提供任何实际功能。                  |
+| `example` | 安装用于运行位于<IconLink text="examples （范例）" href={rootURL("examples")}/>目录下的范例的依赖项。其只用于范例，而未用于本项目自身。 |
+|   `dev`   | 安装开发者依赖项。构建模块包的时候才有可能需要这些依赖项。                                                                              |
 
 ## 安装GitHub版本 {#install-the-github-version}