授权协议: BSD-3-Clause
开发语言: Python
操作系统: 跨平台
收录时间: 2019-09-10
提 交 者: SaintIC

rtfd是一个基于sphinx来构建文档的命令工具,用来生成并阅读文档。

类似于 readthedocs.org 提供的服务,当然功能是比不上的,只是作为备用工具使用。

它源于我在readthedocs上遇到的致命问题以及一直想造这么个轮子的想法,在一个脚本的基础上,快速地加了其他代码,形成的一个命令行工具,所以它不是那么优雅,代码也不美观~~

只是,当你不想用或不能用readthedocs时,可以用它构建你的文档。

特性:

  • 使用简单,依靠命令行、API
  • 配置简单,rtfd配置依靠ini文件,构建文档时也支持直接写ini文件配置文档所需环境
  • 支持https(HTTP2、TLS1.3),支持自定义域名(包含HTTPS的支持)
  • 文档项目直接支持多语言(翻译)和多标签(版本),在页面右下角有按钮可以显示
  • 支持webhook触发、文档构建状态的徽章、文档单一版本等
  • 允许github公开仓库和私有仓库

目前相对于readthedocs不足的特性是:

  • 仅支持github
  • 不支持生成PDF、EPUB
  • 不支持添加翻译版本(目前翻译版本要求直接包含在文档中才行)
  • 不支持设置子项目、构建时环境变量等
展开阅读全文

代码

的 Gitee 指数为
超过 的项目

rtfd 的相关资讯

还没有任何资讯

rtfd 的相关博客

文件后缀与mime类型对应表

//文档文件类型的 .ai application/postscript .eps application/postscript .exe application/octet-stream .doc applicatio...

多格式文档转换PDF软件:Enolsoft PDF Creator

想要把文件转化为PDF格式?enolsoft pdf creator mac破解版是一款macOS平台的多格式文档转换PDF软件,能够帮助用户非常方便地...

文件后缀与Mime类型对照表

以下是一些文件后缀(扩展名)对应的MIME类型的一个对照表,方便iis中或其他服务器对相应的文件进行解析。有些文件的后缀名没...

5款 Mac 常用PDF阅读和编辑软件推荐

PDF和Word、TXT等文档一样,都是我们最常用的文档格式,那么一款好用的浏览或编辑PDF的工具就很有必要了,今天和大家分享5款M...

Sphinx + GitHub + ReadtheDocs 创建电子书

Read the Docs是一个在线文档托管服务, 你可以从各种版本控制系统中导入文档。一般来讲,这个非常适合写软件文档以及编写一些...

rtfd 的相关问答

还没有任何问答,马上提问

评论 (0)

加载中
更多评论
0 评论
5 收藏
分享
返回顶部
顶部