sphinx使用初体验笔记

#安装
pip install sphinx -i https://pypi.tuna.tsinghua.edu.cn/simple

#更换国内源
 清华源
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple

# 阿里源
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
# 腾讯源
pip config set global.index-url https://mirrors.cloud.tencent.com/pypi/simple
# 豆瓣源
pip config set global.index-url http://pypi.douban.com/simple/

#换回默认源
pip config unset global.index-url

#离线下载安装包
pip download 包名 -d "路径(windows下双引号来表示文件夹)"
#离线安装
pip install <.whl 或者源文件包名>

#开始
sphinx-quickstart

#编译
make html

#Sphinx 默认不支持 Markdown 语法，但可以通过 recommonmark 插件来支持。另外，如果需要支持 markdown 的表格语法，还需要安装 sphinx-markdown-tables 插件。这两个插件其实我们前面已经安装好了，现在只需要在 conf.py 配置文件中添加扩展支持即可。
 extensions = [
     'recommonmark',
     'sphinx_markdown_tables'
 ]

#遇到的问题 搜索不支持中文
#解决方案
pip install jieba
#在conf.py配置文件中添加html_search_language = 'zh'并重新make html

#进阶 自动编译 sphinx-autobuild source build/html
#https://studynotes.readthedocs.io/zh/main/struct/extend/autobuild.html