在类维基环境中使用Python文档(带一些自动文档功能)

3 投票
1 回答
796 浏览
提问于 2025-04-16 19:19

我调查了一下,对sphinx抱有很高的期待。

不过,它并不能完全满足我对文档框架的所有需求。以下是我想要的功能:

  • 像维基百科那样的环境(也就是说,可以在网上编辑),并且有版本跟踪功能
  • 支持自动文档生成(也就是可以导入文档字符串等)
  • (理想情况下)能连接到版本管理,这样就可以查看之前版本的代码

有没有这样的东西呢?

1 个回答

1

GitHub的Gollum是一个简单的、基于Git的维基网站,拥有很棒的接口和本地前端,可能是一个不错的解决方案。它支持reStructured Text,这种格式你可能听说过,它和Sphinx使用的是同一种标记语言。

撰写回答