开始使用

安装及主题配置

1.安装sphinx

pip install sphinx -i https://mirrors.aliyun.com/pypi/simple/

2.初始化

创建好文件夹，然后在相应文件夹中运行初始化命令

sphinx-quickstart

运行初始化命令会生成一些文件，需要修改，才能更好的使用

3.本人习惯使用markdown,所以安装markdown相关解析库

pip install myst_parser -i https://mirrors.aliyun.com/pypi/simple/

4.安装一个自己喜欢的主题

pip install furo -i https://mirrors.aliyun.com/pypi/simple/

5.修改配置conf.py文件

# 一些扩展配置
extensions = [
    'sphinx.ext.duration',
    'myst_parser',
]
# 解析md文件的配置
source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}

# 主题配置
html_theme = 'furo'