Sphinx页面与wiki页面

Question

如果您只想创建HTML文档，使用Sphinx作为文档API来使用MediaWiki有什么好处？

Answer 1

这实际上取决于您和您（以及适用的人）习惯的工作流程。不仅仅是优点，还有品味和你习惯的事情。对我来说，sphinx-doc的优势在于：

• 在外部编辑器中轻松编辑文件
• 使用VCS（svn，fossil或git）对文档进行版本控制
• 我习惯于降价语法

但我认为，对于每一点，有人可能会为mediawiki争论一个优势，因此我认为这是一个品味和偏好的问题。

但是，如果您与非技术人员合作：mediawiki或fossil-wiki将更容易添加到项目/评论页面并进行更正。出于同样的原因，如果您的文档需要与其他文档（代码或数据）保持同步，那么同一版本控制系统中的sphinx-doc将符合我的偏好。

我提到fossil-wiki因为它提供了两种选项的组合，并且对于某些项目提供了两全其美的优势。您可以拥有人们可以在传统意义上编辑的wiki页面（通过在线前端）和.wiki页面，这些页面被编辑为好像它们是源代码并且无法通过前端进行更改。再一次，这对你来说是否有意义取决于你的用例和写作风格和习惯。