diff --git a/docs/source/appdevelop/convertmodel.md b/docs/source/appdevelop/convertmodel.md new file mode 100644 index 0000000..aa4b226 --- /dev/null +++ b/docs/source/appdevelop/convertmodel.md @@ -0,0 +1,5 @@ +# 转换模型 + +1.xxx +2.xxx +3.xxx \ No newline at end of file diff --git a/docs/source/appdevelop/createmodel.md b/docs/source/appdevelop/createmodel.md new file mode 100644 index 0000000..cdc82ae --- /dev/null +++ b/docs/source/appdevelop/createmodel.md @@ -0,0 +1,5 @@ +# 定义模型 + +1.xxx +2.xxx +3.xxx \ No newline at end of file diff --git a/docs/source/appdevelop/index.rst b/docs/source/appdevelop/index.rst new file mode 100644 index 0000000..023bc96 --- /dev/null +++ b/docs/source/appdevelop/index.rst @@ -0,0 +1,10 @@ +应用开发 +======== + +.. toctree:: + :maxdepth: 1 + + createmodel + convertmodel + inference + diff --git a/docs/source/appdevelop/inference.md b/docs/source/appdevelop/inference.md new file mode 100644 index 0000000..80f8bdb --- /dev/null +++ b/docs/source/appdevelop/inference.md @@ -0,0 +1,5 @@ +# 模型部署 + +1.xxx +2.xxx +3.xxx \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 102685f..bb04f40 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,6 +6,9 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +import datetime + project = 'MindSpore Signal+ 使用手册' copyright = '2025 - ' + str(datetime.date.today().year) + ', NUDT-674' author = 'NUDT-674' diff --git a/docs/source/functionlib/index.rst b/docs/source/functionlib/index.rst new file mode 100644 index 0000000..35a7c3f --- /dev/null +++ b/docs/source/functionlib/index.rst @@ -0,0 +1,7 @@ +算子库支持 +========== + +.. toctree:: + :maxdepth: 1 + + supported_op diff --git a/docs/source/functionlib/supported_op.md b/docs/source/functionlib/supported_op.md new file mode 100644 index 0000000..c95d8ab --- /dev/null +++ b/docs/source/functionlib/supported_op.md @@ -0,0 +1 @@ +# 算子库支持情况 \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 5cbdef0..948e3bf 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,5 +9,8 @@ MindSpore Signal+ 使用手册 .. toctree:: :maxdepth: 2 - - installation/index \ No newline at end of file + + quickstart/index + appdevelop/index + functionlib/index + refdoc/index \ No newline at end of file diff --git a/docs/source/installation/installation.md b/docs/source/installation/installation.md deleted file mode 100644 index 8de53ab..0000000 --- a/docs/source/installation/installation.md +++ /dev/null @@ -1,3 +0,0 @@ -# 环境安装 - -1.安装mindspore \ No newline at end of file diff --git a/docs/source/quickstart/helloworld.md b/docs/source/quickstart/helloworld.md new file mode 100644 index 0000000..126d369 --- /dev/null +++ b/docs/source/quickstart/helloworld.md @@ -0,0 +1,2 @@ +# 第一个例子 + diff --git a/docs/source/installation/index.rst b/docs/source/quickstart/index.rst similarity index 60% rename from docs/source/installation/index.rst rename to docs/source/quickstart/index.rst index 682fa19..0ec30ce 100644 --- a/docs/source/installation/index.rst +++ b/docs/source/quickstart/index.rst @@ -1,4 +1,4 @@ -环境安装 +快速入门 ======== .. toctree:: @@ -6,4 +6,5 @@ installation - + helloworld + overview diff --git a/docs/source/quickstart/installation.md b/docs/source/quickstart/installation.md new file mode 100644 index 0000000..5f37b7d --- /dev/null +++ b/docs/source/quickstart/installation.md @@ -0,0 +1,3 @@ +# 环境安装 + +1.环境安装 diff --git a/docs/source/quickstart/overview.md b/docs/source/quickstart/overview.md new file mode 100644 index 0000000..d32e5fd --- /dev/null +++ b/docs/source/quickstart/overview.md @@ -0,0 +1,2 @@ +# 整体概览 + diff --git a/docs/source/refdoc/index.rst b/docs/source/refdoc/index.rst new file mode 100644 index 0000000..d7fa4b1 --- /dev/null +++ b/docs/source/refdoc/index.rst @@ -0,0 +1,11 @@ +参考资料 +======== + +.. toctree:: + :maxdepth: 1 + + + mindspore + signal_scheduling + + diff --git a/docs/source/refdoc/mindspore.md b/docs/source/refdoc/mindspore.md new file mode 100644 index 0000000..18a611a --- /dev/null +++ b/docs/source/refdoc/mindspore.md @@ -0,0 +1,4 @@ +# 官方资料 + +1.MindSpore +2.Minsdpore Lite diff --git a/docs/source/refdoc/signal_scheduling.md b/docs/source/refdoc/signal_scheduling.md new file mode 100644 index 0000000..4fcc2be --- /dev/null +++ b/docs/source/refdoc/signal_scheduling.md @@ -0,0 +1,3 @@ +# MindSpore Signal+ 调度方案 + +1.xxx diff --git a/requirements.txt b/requirements.txt index db1ce0c..231b7c1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ -sphinx==8.1.3 -sphinx-rtd-theme==3.0.2 -myst-parser==4.0.1 \ No newline at end of file +sphinx +sphinx-rtd-theme +myst-parser \ No newline at end of file