rtfd构建文档的命令工具

联合创作 · 2023-10-02 04:37

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

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

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

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

特性:

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

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

  • 仅支持github
  • 不支持生成PDF、EPUB
  • 不支持添加翻译版本(目前翻译版本要求直接包含在文档中才行)
  • 不支持设置子项目、构建时环境变量等
浏览 6
点赞
评论
收藏
分享

手机扫一扫分享

编辑 分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

编辑 分享
举报