摘要: 引言 Github Github是一个托管网站,目前主要用来托管代码,当然托管其他的也可。但是网不好的小伙伴可以考虑使用Gitee作为平替。 Sphinx Sphinx是什么? Sphinx是一个自动生成文档的工具,可以用简洁的语法快速生成优雅的文档。 哪些场景要用Sphinx? 如果想要写书,不想 阅读全文
posted @ 2023-04-02 15:35 Danno 阅读(387) 评论(0) 推荐(1) 编辑
摘要: 引言 接着上两篇文章 Github + Sphinx+Read the docs 实战入门指南(一) Github + Sphinx+Read the docs 实战入门指南(二) 我们已经成功地将Sphinx文档部署到了Read the docs网站,但是这个文档,我们不想每次都要手动更新内容,想 阅读全文
posted @ 2023-04-02 15:33 Danno 阅读(57) 评论(0) 推荐(0) 编辑
摘要: 引言 接上一篇Github + Sphinx+Read the docs 实战入门指南(一),这一篇主要讲解如何自动将指定文档内容部署到Read the docs中。 对于文档,一般有以下基本要求: 只维护一份,其他地方自动同步更新 可以根据代码注释,动态更新维护相应的API文档 支持检索 多版本之 阅读全文
posted @ 2023-04-02 15:33 Danno 阅读(82) 评论(0) 推荐(0) 编辑
摘要: 引言 Github Github是一个托管网站,目前主要用来托管代码,当然托管其他的也可。但是不好的小伙伴可以考虑使用Gitee作为平替。 Sphinx Sphinx是什么? Sphinx是一个自动生成文档的工具,可以用简洁的语法快速生成优雅的文档。 哪些场景要用Sphinx? 如果想要写书,不想陷 阅读全文
posted @ 2023-04-02 11:53 Danno 阅读(29) 评论(0) 推荐(0) 编辑