Sphinx提供软件文档有什么好的选择？

Question

我想知道当我想为软件项目提供静态HTML文档时，是否还有其他的狮身人面像替代品。狮身人面像似乎确定，但主要用于Python领域。我对可能在各种项目中使用的解决方案感兴趣，不仅仅涉及Python。

我的目标是在降价或类似的东西记录的东西，事后产生将被传递到用户（管理员）的静态HTML网站

我也看到咕噜但这依赖于GitHub的:(

Answer 1

您认为Sphinx主要用于Python领域是一个大问题吗？Sphinx确实是用Python编写的，主要面向Python文档。但是恕我直言，其中一个优点是它可以是用于记录任何东西

狮身人面像会让你做你想问的问题：“document在降价或类似的东西和事后产生一个静态的HTML网站“。狮身人面像使用restructuredtext，这是“或类似的东西”位。

如果你想尝试一些有点不同，我会建议docbook。

Answer 2

你可能想要考虑给Gollum另外一看。我会提到我对Gollum的想法，因为我的需求听起来与您的要求类似。我最近已经开始使用Gollum进行Rails项目文档编制工作，并且迄今为止我的经验非常积极。它由Github的人开发，但它不受Github服务限制，可独立于Github使用。

这是一个非常活跃的开源项目，有很多提交者。该框架是Sinatra，您可以轻松地在个人工作站上运行它。我让Gollum服务器在我的开发机器上运行并直接编辑Markdown文件，然后在本地Gollum服务器中查看结果。如果您将编辑器设置为通过按键自动添加更新，这一点尤其好。当你准备好时，你可以使用this项目来从你的Gollum wiki中生成一个静态html网站。

另外，因为它在幕后使用git，所以在版本控制和git的所有功能中都内置了git。