Ruby相当于Sphinx文档生成器？

Question

Ruby有一些很好的文档生成器，比如Yard，rDoc，甚至是Glyph。问题在于Sphinx有网站，PDF，epub，LaTex ......等等。它在重组文本中完成所有这些事情。

在Ruby世界中有替​​代方案吗？也许是一个程序组合？如果我也可以使用Markdown，那会更好。

Answer 1

从版本1.0开始，Sphinx就有了一个“域”概念，它是从Python和/或C以外的语言标记代码实体（如方法调用，对象，函数等）的方法。

有一个ruby domain，所以你可以使用Sphinx本身。你唯一想念的就是（我认为）是Sphinx能够使用autodoc扩展自动从源创建文档，该扩展专门用于Python代码。

Answer 2

如果您想使用Markdown，您可以查看JDoc，这是一个非常简单的基于Ruby的文档框架，它允许您使用广泛支持的标记并将其置于源代码管理之下。它允许您在所选的文本编辑器中编辑文档，它支持：

• Markdown或Textile
• 语法高亮显示
• 简单的内部链接
• 分层文档结构（对大型项目有用）
• 可自定义的样式和结构（但它看起来也很好看）

它生成静态HTML，因此生成的文档很容易托管，对您的服务器负载没有太大影响。

要查看它的实际效果，请查看wpmvc.org。

Answer 3

另外两个选项是使用Middleman，它是一个静态站点生成器，接受Kramdown或Markdown作为输入。

还有专门针对使用Middleman（两者都在GitHub上）的技术文档设计的框架，包括lord / slate和pnerger / dpslate（后者是前者的分支，并提供了一些不合适的增强功能用于拉动）。 Slate格式提供了一种文档格式，其中包括Sphinx的许多功能以及一些其他增强功能。它具有文档的三窗格视图，其中包括自动生成的目录，主中心主体，然后是右侧的示例代码面板。与Sphinx一样，示例代码具有语法突出显示。