Ruby 等同于 Sphinx 文档生成器?

标签 ruby markdown documentation-generation python-sphinx restructuredtext

Ruby 有一些不错的文档生成器,例如 Yard、rDoc,甚至 Glyph。问题是 Sphinx 可以做网站、PDF、epub、LaTex 等。它在重组文本中完成所有这些事情。

在 Ruby 世界中有替​​代方案吗?也许是程序的组合?如果我也能使用 Markdown 就更好了。

最佳答案

自 1.0 版以来,Sphinx 有了“域”的概念,它是从 Python 和/或 C 以外的语言标记代码实体(如方法调用、对象、函数等)的方法。

有一个ruby domain , 所以你可以只使用 Sphinx 本身。您唯一会缺少的(我认为)是 Sphinx 使用 autodoc 从源代码自动创建文档的能力。扩展,专门用于 Python 代码。

关于Ruby 等同于 Sphinx 文档生成器?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/9372188/

相关文章:

c# - SandCaSTLe 中的实体文件报告

jquery - Rails jquery 适用于本地主机,但不适用于 heroku

ruby - gsub 部分替换

ruby 日期格式字符

html - Markdown 中的样式化文章(HTML 和 CSS)

web-services - 是否有用于 SOAP Web 服务的文档工具?

ruby-on-rails - 在 Ruby 或 Rails 中,将东部时间转换为 UTC 的最佳方法是什么?

r - 如何修复 "Could not find shape for Powerpoint content Error: pandoc document conversion failed with error 63"错误

image - 如何在当前目录中的 GitLab markdown 中引用路径以 ./dot 斜杠开头的图像?

json - RPC API 的文档工具