数值模拟研究科研手册

作者：崔智文说明：本手册只是个人在科研过程中遇到的问题与解决方案，仅供参考。

如何启用编辑

如果有需要建立新的doc可以参考官网流程https://www.sphinx-doc.org/zh_CN/master/tutorial/getting-started.html#setting-up-your-project-and-development-environment 目前的设置不需要建立新文档，此连接仅做参考。
如果需要开发文档，可以按照以下流程配置
- 我们通过虚拟环境变量的方式加载sphinx, 其中python需要3.x版本，如果系统默认python是连接2.x版本的话，可以把python 替换为python3
```
python -m venv .venv
python3 -m venv .venv // only if python is unavailable
```
- 加载虚拟环境
```
source .venv/bin/activate
```
  如果后面想要卸载该虚拟环境，可以使用
```
deactivate
```
- 同时，本文档采用furo主题
```
 pip install furo
```
- 为支持markdown
```
pip install --upgrade myst_parser
pip install --upgrade sphinx_markdown_tables
```
- 为了方便环境配置，我写了一个自动配置的脚本，可运行以下命令自动配置
```
source .venv/bin/activate
pip install furo
pip install --upgrade myst_parser
pip install --upgrade sphinx_markdown_tables
```
- 如何修改了文档，可以使用以下命令编译新的html
```
make clean
make html
```
- 如果需要部署到github page上，可以运行
```
    bash run.sh
```
  并在setting中选择/docs为html根目录
如果只是查看文档，可直接打开build/html/index.html