Browse Source

update docs

master
ccsuzzh 3 months ago
parent
commit
d6ba957bfb
9 changed files with 117 additions and 1 deletions
  1. +1
    -0
      .gitignore
  2. +5
    -1
      README.md
  3. +20
    -0
      docs/Makefile
  4. +35
    -0
      docs/make.bat
  5. +28
    -0
      docs/source/conf.py
  6. +13
    -0
      docs/source/index.rst
  7. +9
    -0
      docs/source/installation/index.rst
  8. +3
    -0
      docs/source/installation/installation.md
  9. +3
    -0
      requirements.txt

+ 1
- 0
.gitignore View File

@@ -0,0 +1 @@
build/

+ 5
- 1
README.md View File

@@ -1,2 +1,6 @@
# mindspore_signal_doc
# MindSpore Signal+ 文档
### 环境安装
pip install -r requirements.txt


### 文档构建
sphinx-build -M html docs/source/ docs/build/

+ 20
- 0
docs/Makefile View File

@@ -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)

+ 35
- 0
docs/make.bat View File

@@ -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

+ 28
- 0
docs/source/conf.py View File

@@ -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']

+ 13
- 0
docs/source/index.rst View File

@@ -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

+ 9
- 0
docs/source/installation/index.rst View File

@@ -0,0 +1,9 @@
环境安装
========

.. toctree::
:maxdepth: 1

installation


+ 3
- 0
docs/source/installation/installation.md View File

@@ -0,0 +1,3 @@
# 环境安装

1.安装mindspore

+ 3
- 0
requirements.txt View File

@@ -0,0 +1,3 @@
sphinx==8.1.3
sphinx-rtd-theme==3.0.2
myst-parser==4.0.1

Loading…
Cancel
Save