当前位置: 首页 > news >正文

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

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

http://www.lryc.cn/news/397113.html

相关文章:

  • 【ChatGPT 消费者偏好】第二弹:ChatGPT在日常生活中的使用—推文分享—2024-07-10
  • Webpack配置及工作流程
  • 华为ensp实现防火墙的区域管理与用户认证
  • 深入解析 Laravel 策略路由:提高应用安全性与灵活性的利器
  • Java | Leetcode Java题解之第228题汇总区间
  • 使用Simulink基于模型设计(三):建模并验证系统
  • 基于go 1.19的站点模板爬虫
  • 0基础学会在亚马逊云科技AWS上搭建生成式AI云原生Serverless问答QA机器人(含代码和步骤)
  • [PaddlePaddle飞桨] PaddleOCR图像小模型部署
  • C语言 | Leetcode C语言题解之第227题基本计算题II
  • kafka.common.KafkaException: Socket server failed to bind to xx:9092
  • 【JS+H5+CSS实现烟花特效】
  • uniapp小程序使用webview 嵌套 vue 项目
  • 命令模式在金融业务中的应用及其框架实现
  • WordPress的性能优化有哪些方法?
  • 【Python基础】代码如何打包成exe可执行文件
  • Golang | Leetcode Golang题解之第227题基本计算器II
  • 云端美味:iCloud中食谱与餐饮计划的智能存储方案
  • leetcode:1332. 删除回文子序列(python3解法)
  • 智慧交通的神经中枢:Transformer模型在智能交通系统中的应用
  • PCIe驱动开发(1)— 开发环境搭建
  • YOLOv10改进 | Conv篇 | CVPR2024最新DynamicConv替换下采样(解决低FLOPs陷阱)
  • 变革设计领域:Transformer模型在智能辅助设计中的革命性应用
  • Spring——配置说明
  • 禁用华为小米?微软中国免费送iPhone15
  • nginx初理解
  • FreeCAD源码分析:属性系统
  • C++入门 模仿mysql控制台输出表格
  • SpringBoot新手快速入门系列教程五:基于JPA的一个Mysql简单读写例子
  • 开源大势所趋