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

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/Einstellung/article/details/85009001

之前看到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。

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

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

猜你喜欢

转载自blog.csdn.net/Einstellung/article/details/85009001