做一个像Keras在线技术文档(Sphinx + GitHub + Read the Docs)

本文分享了使用Sphinx创建在线技术文档的过程,包括安装Sphinx、配置文档目录、更改主题及托管到GitHub和ReadtheDocs的方法。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

之前看到Keras的中文文档十分心动也想自己做一个,最终被我做成了。这里写一下制作流程。

制作效果感觉还是不错的

在这里插入图片描述

链接:https://opencv-learning.readthedocs.io/zh_CN/latest/index.html

首先,安装一下Sphinx

pip install sphinx sphinx-autobuild sphinx_rtd_theme

之后再index.rst里面修改你想要的文章目录,当然这个文章目录里面的内容可以写一个Markdown文件传进去。

之后进行make html

如果想要更改主题,可以在source/conf.py里面修改,之后进行GitHub托管。再之后绑定Read the Docs。

我录了一个视频放在网易,详细如何制作可以看我的视频:

链接:如何制作在线技术文档

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Einstellung

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值