Sphinx提供软件文档的任何好的替代品？ [英] Any good alternatives for Sphinx to provide software documentation?

问题描述

我想知道当我想为软件项目提供静态html文档时是否有Sphinx的任何好的选择。狮身人面像似乎没问题，但大多在Python区域使用。我感兴趣的一个解决方案，可能可以用于各种项目，不仅与Python相关。

我的目标是将文件的文件或类似的东西记录下来生成一个静态html站点，将被传递给用户（管理员）

我也看过Gollum，但是这与GitHub有关：（

解决方案

你认为Sphinx主要用于Python领域是一个大问题吗？Sphinx是用Python编写的，主要面向Python文档，但是IMHO的优点之一就是可以用来记录任何东西。

狮身人面像会让你完全按照你的要求：类似的东西，之后产生一个静态的html网站。狮身人面像使用重组文本，这是或如果你想尝试一些不同的东西，我会建议 docbook 。

i was wondering if there are any good alternatives to Sphinx when i want to provide static html documentation for software projects. Sphinx seems ok but is mostly used in the Python area. I am interested in a solution that could potentially be used in all kinds of projects not only Python related.

My goal is to document stuff in markdown or something like that and afterwards generate a static html site that will be delivered to the users (administrators)

I have also seen Gollum but this is tied to GitHub :(

解决方案

Do you think it is a big problem that Sphinx is mostly used in the Python area? It is true that Sphinx is written in Python and primarily geared towards Python documentation. But IMHO, one of the strengths is that it can be used to document anything.

Sphinx will let you do exactly what you ask: "document stuff in markdown or something like that and afterwards generate a static html site". Sphinx uses restructuredtext, which is the "or something like that" bit.

If you want to try something a little different, I would suggest docbook.

这篇关于Sphinx提供软件文档的任何好的替代品？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！