Sphinx入门教程

1.新建sphinx文件夹

输入命令行以下命令行安装sphinx

pip install sphinx

再输入命令，使用向导创建文档项目

sphinx-quickstart 

创建完成后，sphinx_demo文件夹新增了以下文件

 2.运行初始化项目文档

命令窗口输入命令，生成html文件

.\make html

 可打开html文件查看文档页面

 

 3.修改项目配置

（1）修改项目主题

A.控制台输入命令，安装主题

pip install furo

 B.修改配置项

 C.命令行输入‘.\make clean’，再输入命令行‘.\make html’，打开页面

 

（2）兼容markdown文件

A.在source文件夹下，新增.md文件，然后将该文件添加至index.rst项目入口文件中，运行项目，不兼容报错

 

B.命令行 输入命令，安装插件

pip install --upgrade myst-parser

C.修改配置项

D.再次运行项目，运行成功，项目兼容.md文件

  

（3）sphinx配置为解析具有扩展名的所有文件 .md 和 .txt 作为 Markdown

 

 4.配置项目首页

可修改首页标题，引入其他文件，修改目录树的属性等，其他属性参考官方文档

maxdepth属性

 

 hidden属性

 numbered属性

5.子目录可以再配置其子目录