Sphinx开发网页基本流程

pip install sphinx

F1：在新文件目录输入cmd回车

F2：打开cmd，切换当前路径至新文件夹

在cmd中输入sphinx-quickstart，新建项目，过程如下：

你会发现，当前文件夹生成了如下文件！

1.如果你选择用markdown而不是rst来编写网页，请下载myst_parser

pip install myst_parser

2.在sphinx-themes选择主题

以选择Read the Docs主题为例，你需要安装以下的包

pip install sphinx-rtd-theme

将下面的代码复制到conf.py中，请根据实际情况做相应更改（比如项目名，扩展的包等）

# -- Project configuration -----------------------------------------------------
project = 'HappyLaber'
author = 'Happy'
copyright = '2022, Happy'
release = '1.0.0'

# -- General configuration ------------------------------------------------
source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}

extensions = [
    'myst_parser',            # Markdown
    'sphinx.ext.mathjax',     # Math
    'sphinx.ext.githubpages', # Gighub
]
mathjax_path = "https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML"

# -- Options for HTML output ----------------------------------------------
templates_path = ['_templates']
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_theme_options = {
    "prev_next_buttons_location": "bottom",
}

将index.rst更改为index.md，然后粘贴下面代码，构建Matlab文件夹，在文件夹下建立index.md文件，同理，构建Python文件夹，在文件夹下建立index.md文件，在两个index.md中输入你的笔记。

```{toctree}
:caption: 编程
:maxdepth: 1

Matlab/index
Python/index
```

在主文件夹(包含make.bat的那个文件夹，这里是HappyLaber)下打开cmd，输入如下代码。

make clean
make html

在下面的路径中打开index.html，即可看到你的网页。

Sphinx不支持部分原生的Markdown语法，因此产生了Markdown的拓展语法，详情见面包多