docs | 使用 sphinx 转化rst文件为html文档

biomooc2024-07-11 23:28

1. 效果图

book 风格。

优点：

极简风格
右边有标题导航
左侧是文件导航，可隐藏

2. 使用方式

reST 格式，比markdown格式更复杂。

推荐使用 book 风格。

文档构建工具是 sphinx，是一个python包。

复制代码

$ pip3 list | grep -i Sphinx
Sphinx                        7.3.7
sphinxcontrib-applehelp       1.0.8
sphinxcontrib-devhelp         1.0.6
sphinxcontrib-htmlhelp        2.0.5
sphinxcontrib-jsmath          1.0.1
sphinxcontrib-qthelp          1.0.7
sphinxcontrib-serializinghtml 1.1.10


$ pip3 install sphinx-book-theme

# conf.py 
html_theme = 'sphinx_book_theme'

$ make html

注意：上文包名字的下划线_和减号-的区别。