构建文档的命令工具 rtfd

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
  • 不支持添加翻译版本(目前翻译版本要求直接包含在文档中才行)
  • 不支持设置子项目、构建时环境变量等
的码云指数为
超过 的项目
加载中

评论(0)

暂无评论

暂无资讯

暂无问答

GitHub上有趣的python资料

和大家分享一下我整理的有趣的GitHub repository,最新版本信息请移步项目地址: repo_starred 大家可以给我发送issue 分享自己觉得有趣的资源 本文的主题是python,正文如下: navigation S...

2016/02/12 18:25
129
1
可爱的python测试开发库(python测试开发工具库汇总)

欢迎转载,转载请注明来源: github地址 谢谢点赞 本文地址 Python测试开发库 参考资料 https://github.com/vinta/awesome-python https://github.com/atinfo/awesome-test-automation http...

没有更多内容

加载失败,请刷新页面

没有更多内容

返回顶部
顶部