【问题标题】:Sphinx pages vs wiki pages狮身人面像页面与维基页面
【发布时间】:2014-02-04 21:40:31
【问题描述】:

如果您只想创建 HTML 文档,使用 Sphinx 作为文档 api 与使用 MediaWiki 相比有什么优势?

【问题讨论】:

    标签: mediawiki python-sphinx


    【解决方案1】:

    这实际上完全取决于您以及与您一起工作的人(如果适用)所习惯的工作流程。不仅仅是优点,它还取决于品味和您的习惯。对我来说 sphinx-doc 的感知优势是:

    • 在外部编辑器中更轻松地编辑文件
    • 使用 VCS(svn、fossil 或 git)对文档进行版本控制
    • 我习惯markdown语法

    但我认为,对于这些观点中的每一个,都有人认为 mediawiki 具有优势,因此我认为这是一个品味和偏好问题。

    但是,如果您与非技术人员合作:mediawiki 或化石维基将更容易让他们添加到项目/评论页面并进行更正。同样,如果您的文档需要与其他文档(代码或数据)同步,那么我更喜欢同一版本控制系统中的 sphinx-doc。

    我提到fossil-wiki 是因为它提供了这两种选择的组合,并且对于某些项目而言,它提供了两全其美的优势。您可以拥有人们可以在传统意义上(通过在线前端)编辑的 wiki 页面,以及像源代码一样编辑且无法通过前端更改的 .wiki 页面。同样,这对您是否有意义取决于您的用例以及写作风格和习惯。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2010-11-28
      相关资源
      最近更新 更多