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

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

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

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

做一个像Keras在线技术文档（Sphinx + GitHub + Read the Docs）相关推荐

docfx 做一个和微软一样的文档平台
开发中,有一句话叫最不喜欢的是写文档,最不喜欢的是看别人家代码没有文档.那么世界上文档写最 la 好 ji 的就是微软了,那么微软的api文档是如何做的?难道请了很多人去写文档? 实际上微软有工具用 ...
iris 在线技术文档归总
https://github.com/snowlyg/iris/wiki ...
一个非常适合IT团队的在线API文档、技术文档工具
独乐乐,不如众乐乐. 之前单独写过一篇文章<介绍几款常用的在线 API 管理工具>,今天又发现个不错的工具,推荐给大家. ShowDoc 每当接手一个别人开发好的模块或者项目,看着那些没有 ...
【资源推荐】良心之作！超过 10000+ 的互联网团队正在使用的在线 API 文档、技术文档工具...
搞开发的同学都知道一个好的 API 文档是有多重要! 每当接手一个别人开发好的项目,看着那些没有注释的代码,真的头大. 程序员都很希望别人能写技术文档,因为可以提高自己开发的效率,而往往自己却很不希望 ...
良心之作！超过 10000+ 的互联网团队正在使用的在线 API 文档、技术文档工具
搞开发的同学都知道一个好的 API 文档是有多重要! 每当接手一个别人开发好的项目,看着那些没有注释的代码,真的头大. 程序员都很希望别人能写技术文档,因为可以提高自己开发的效率,而往往自己却很不希望 ...
在线API文档、技术文档工具ShowDoc
[个人开源作品]在线API文档.技术文档工具ShowDoc ShowDoc是什么每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂.文档呢?!文档呢?!Show me t ...
VuePress 手摸手教你搭建一个类Vue文档风格的技术文档/博客
前言: VuePress是尤大为了支持 Vue 及其子项目的文档需求而写的一个项目,VuePress界面十分简洁,并且非常容易上手,一个小时就可以将项目架构搭好.现在已经有很多这种类型的文档,如果你有 ...
一款适合IT团队的在线API文档、技术文档工具-showdoc介绍
还在为word文档传来传去查阅不方便而烦恼吗,还在为查看数据库字段含义不方便而烦恼吗,还在为编写接口文档而烦恼吗?今天为大家推荐一款适合IT团队的在线API文档.技术文档工具,有免费开源和在线托管的版 ...
在线API文档,技术文档工具源码ShowDoc
介绍: ShowDoc是一个非常适合IT团队的在线API文档.技术文档工具. 通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档.数据字典文档.技术文档.在线excel文 ...

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

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

做一个像Keras在线技术文档（Sphinx + GitHub + Read the Docs）相关推荐

最新文章

热门文章