sphinx 环境搭建

sphinx 环境搭建

搭建 python 环境

1.使用 Anaconda 创建 python 虚拟环境

1. 创建python虚拟环境
2. 激活环境
3. 切换至sphinx环境

conda create -n sphinx python=3.8
conda activate
conda activate sphinx

安装 sphinx 和相关依赖包

1.安装 sphinx

1. 在python环境安装sphinx
2. 安装完成后，验证sphinx是否安装成功

conda install sphinx
sphinx-build --version

2.安装依赖包

1. 安装 Markdown 插件
2. 安装 readthedocs 主题插件
3. 安装多语言工具
4. 安装 sphinxcontrib.plantuml
5. 安装 docxbuilder
6. 安装 esbonio

conda install recommonmark
conda install sphinx_rtd_theme
conda install sphinx_intl
conda install sphinxcontrib.plantuml
conda install docxbuilder
conda install esbonio

安装 PlantUML

PlantUML是一个可以快速编写UML图的组件。

软件要求：

• Java: 是运行PlantUML的必需条件, 请在您的环境中安装Java。
• graphviz-dot: 可选的, 但是建议安装 (如果想绘制除 时序图和活动图以外的图, 就需要安装 Graphviz 软件)。

接下来, 需要下载 plantuml.jar 文件, 保存到本地安装目录。

配置 VSCode 环境

1.VSCode 切换 Python 解释器，使用 Anaconda 创建的 sphinx 解释器

1. Ctrl + Shift + P：输入 Python Select Interpreter
2. 选择 sphinx

2.安装插件 reStructuredText

插件商店搜索：rst，选择 reStructuredText 插件安装

选择 reStructuredText 插件安装

至此，sphinx 环境搭建完成！