Step A. 最终效果

240707-Sphinx配置Pydata-Sphinx-Theme_文档

Step B. 为什么选择Pydata-Sphinx-Theme主题

Step 1. 创建并激活Conda环境
conda create -n rtd_pydata python==3.10
conda activate rtd_pydata
  • 1.
  • 2.
Step 2. 安装默认的工具包
pip install pydata-sphinx-theme
  • 1.
Step 3. 安装额外的工具包

pip install requirements.txt

numpydoc
sphinx-autopsy
sphinxext-rediraffe
sphinx_design
sphinx-copybutton 
myst-parser 
ablog 
jupyter-sphinx 
sphinxcontrib-youtube 
nbsphinx 
sphinx_togglebutton 
jupyterlite_sphinx 
sphinx_favicon 
sphinx_sitemap 
linkify-it-py 
matplotlib pandas 
plotly 
xarray 
ipyleaflet
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.
  • 19.
Step 4. 创建项目并初始化目录

Step C. 参考文献