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

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

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

相关推荐

  1. Excel文件转换HTML文件

    2024-07-12 00:06:02       27 阅读

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2024-07-12 00:06:02       70 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2024-07-12 00:06:02       74 阅读
  3. 在Django里面运行非项目文件

    2024-07-12 00:06:02       62 阅读
  4. Python语言-面向对象

    2024-07-12 00:06:02       72 阅读

热门阅读

  1. 如何调整Oracle SGA的大小

    2024-07-12 00:06:02       25 阅读
  2. 贪心算法-以高校科研管理系统为例

    2024-07-12 00:06:02       27 阅读
  3. ActivityThread与AMS之间关系是什么?

    2024-07-12 00:06:02       21 阅读
  4. 【学习笔记】Redis学习笔记——第7章 压缩列表

    2024-07-12 00:06:02       24 阅读
  5. Mysql中常用函数的使用示例

    2024-07-12 00:06:02       21 阅读
  6. IP地址笔记

    2024-07-12 00:06:02       20 阅读
  7. Grind 75 | 3. merge two sorted lists

    2024-07-12 00:06:02       25 阅读
  8. 6、Redis系统-数据结构-07-QuickList

    2024-07-12 00:06:02       25 阅读
  9. flink使用

    2024-07-12 00:06:02       23 阅读
  10. Github 2024-07-05开源项目日报 Top10

    2024-07-12 00:06:02       21 阅读