【问题标题】:Where to find the Rails API rdoc template在哪里可以找到 Rails API rdoc 模板
【发布时间】:2011-09-03 15:34:38
【问题描述】:

我正在尝试使用 3.5.3 版美化我的 rdoc 文档。我不喜欢内置的 darkfish 主题,所以我试图找到一种方法来用官方 Rails API 文档http://api.rubyonrails.org/ 使用的替换它,但我没有运气在任何地方找到它随时可用的表格。除其他外,我已经搜索了整个 github。

到目前为止我发现的是

这可能有点过时了,它是分叉

两者都不错,但不是我想要的。所以在我开始摆弄这些模板之前,有没有人知道 Rails API 文档使用的模板是否可以在某个地方作为 gem 使用?

谢谢!

【问题讨论】:

    标签: ruby templates rdoc


    【解决方案1】:

    我知道这已经很晚了,但看起来新版本的 Rails 使用了一种叫做 sdoc 的东西,它通过 JavaScript 搜索增强了输出,而且更简洁一些 IMO。做一个简单的“gem install sdoc”就能得到你需要的东西,然后使用rdoc.options << '-f' << 'sdoc'

    github 项目似乎位于https://github.com/voloko/sdoc/

    顺便说一句,谢谢你的问题!如果没有发布最初的答案,我将永远找不到去哪里寻找,并且在我自己的项目中被那个可怕的黑鱼主题所困扰!

    【讨论】:

      【解决方案2】:

      这看起来像。忽略说要执行gem install horo --pre 的说明——这实际上会给您一个较旧的测试版。只需执行gem install horo,您将获得当前的 1.0.3 版本(编辑:我发送了一个拉取请求以更新说明,该说明已被接受)。

      https://github.com/tenderlove/horo

      顺便说一句,我通过查看Rails source code 并查看Rakefile 以查看RDoc 选项发现了这一点。具体来说,第 67 行显示了rdoc.options << '-f' << 'horo'

      【讨论】:

      • 顺便说一句,我也看过那里(railties-3.0.4),但我发现的只是 'rdoc.template = ENV['template'] if ENV['template']'...帮不了我。你到底是在哪里找到的?
      • Rakefile 的第 67 行(不是 Railties rakefile,项目根目录中的 Rakefile)
      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2011-04-02
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多