在windows中使用sphinx创建生成html
在windows中使用sphinx创建生成html
- 前提条件:已安装python(我安装的版本是3.12.6)
安装好sphinx。如果不记得装没装的话可以pip list查一下
安装时可以用pip install进行安装👇
pip install -U sphinx,
完成后,使用下命令检查下是否安装成功
sphinx-build --version - 使用sphinx-quickstart开始创建文档结构:
在终端进入目标目录,然后执行下面的命令:
sphinx-quickstart
这样就创建好了。
可以看到生成的文件夹和文件
index.rst为主文档,config为主目录;ndex.rst的主要功能是作为欢迎页面,并包含“目录树”(或toctree)的根。
现在让sphinx生成html,预览一下生成的html,执行下面的命令:
make html:
如果没有任何报错的话,将如图成功执行。
- 报错解决
我在windows系统上本地执行make html失败了,报错显示 bash: make: command not found
查了查发现linux系统的安装make等操作在我的电脑上无法执行,因为没有sudo,也没有apt-get,也没有wget(hhhhhhhhhh)
但是本地已经配置好了mingw64,并且已经添加到环境变量里面了。因此,问题就是make.exe这个文件默认安装的时候识别的名称。找到它,改成make就可以了。
操作方法如下:
- 首先,检查一下mingw64安装是否成功,可以使用gcc --version进行查看。查得到版本信息,说明配置正确。
- 找到安装路径下的mingw32-make)改为make.exe。默认安装路径的话,通常是C:\Program Files (x86)\mingw64\bin中。
然后再执行make html,就可以顺利执行,生成html文件啦。
posted on 2024-10-25 11:18 potatoInCorner 阅读(4) 评论(0) 编辑 收藏 举报