From d6ba957bfb23ebea9135ec92f08d3f74755f1f97 Mon Sep 17 00:00:00 2001 From: ccsuzzh <1719571694@qq.com> Date: Tue, 12 Aug 2025 17:11:17 +0800 Subject: [PATCH] update docs --- .gitignore | 1 + README.md | 6 +++- docs/Makefile | 20 ++++++++++++++ docs/make.bat | 35 ++++++++++++++++++++++++ docs/source/conf.py | 28 +++++++++++++++++++ docs/source/index.rst | 13 +++++++++ docs/source/installation/index.rst | 9 ++++++ docs/source/installation/installation.md | 3 ++ requirements.txt | 3 ++ 9 files changed, 117 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/installation/index.rst create mode 100644 docs/source/installation/installation.md create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/README.md b/README.md index f60b5c5..001a3cb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ -# mindspore_signal_doc +# MindSpore Signal+ 文档 +### 环境安装 +pip install -r requirements.txt +### 文档构建 +sphinx-build -M html docs/source/ docs/build/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..747ffb7 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..102685f --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,28 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'MindSpore Signal+ 使用手册' +copyright = '2025 - ' + str(datetime.date.today().year) + ', NUDT-674' +author = 'NUDT-674' +release = "alpha" + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ['myst_parser'] + +templates_path = ['_templates'] +exclude_patterns = [] + +language = 'zh_CN' + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'sphinx_rtd_theme' +html_static_path = ['_static'] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..5cbdef0 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,13 @@ +.. MindSpore Signal+ 使用手册 documentation master file, created by + sphinx-quickstart on Tue Aug 12 10:28:49 2025. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +MindSpore Signal+ 使用手册 +========================== + + +.. toctree:: + :maxdepth: 2 + + installation/index \ No newline at end of file diff --git a/docs/source/installation/index.rst b/docs/source/installation/index.rst new file mode 100644 index 0000000..682fa19 --- /dev/null +++ b/docs/source/installation/index.rst @@ -0,0 +1,9 @@ +环境安装 +======== + +.. toctree:: + :maxdepth: 1 + + + installation + diff --git a/docs/source/installation/installation.md b/docs/source/installation/installation.md new file mode 100644 index 0000000..8de53ab --- /dev/null +++ b/docs/source/installation/installation.md @@ -0,0 +1,3 @@ +# 环境安装 + +1.安装mindspore \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..db1ce0c --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +sphinx==8.1.3 +sphinx-rtd-theme==3.0.2 +myst-parser==4.0.1 \ No newline at end of file