gregary / rst

reStructuredText 教程 使用Sphinx生成文档

介绍

reStructuredText 教程 使用Sphinx生成文档

在线预览https://hzz-rst.readthedocs.io/zh_CN/latest/

环境

安装参照博客 以及官网

更加详细的文档

conda install sphinx
conda install -c conda-forge restructuredtext_lint 

主题

主题官网

需要安装 sphinx_theme 官网

pip install sphinx_theme

选择一个主题，然后点击conf.py,复制相应的代码到自己的conf.py,如：

#---sphinx-themes-----
html_theme = 'neo_rtd_theme'
import sphinx_theme
html_theme_path = [sphinx_theme.get_html_theme_path()]