如何通过Passenger运行Yardoc Server？

Question

我知道我可以使用ProxyPass来提供yardoc server个实例，但由于yard使用了Rack，因此不应该通过Passenger运行yard吗？

我该如何设置？ The Passenger Docs描述了针对Rack应用程序的公共目录和config.ru，但它们在Yardoc的源代码中不可用。

Answer 1

Yard不提供方便的机架集成AFAIK，但它具有机架适配器，允许您在像Passenger这样的机架式服务器内运行。

您需要编写自己的config.ru来配置Passenger以使用Yard的RackAdapter类来运行Yard服务器。此外，您需要告诉Yard哪里可以找到它应该提供的文档。

我没有对此进行测试，但这里粗略猜测config.ru应该是什么样的：

require "yard/server/rack_adapter"

run YARD::Server::RackAdapter.new({
  "mylib" => [
    YARD::Server::LibraryVersion.new("mylib", "1.0", "/path/to/mylib/.yardoc")
  ]
})

其中mylib是您要投放的库的名称。

见这里：

• RackAdapter
• LibraryVersion