【问题标题】:roxygen2 equivalent for python [closed]python的roxygen2等价物[关闭]
【发布时间】:2015-03-31 18:56:22
【问题描述】:

我想为用 python 编写的包创建一些文档。

当我在 R 中创建一个包时,roxygen2 会为我做这件事。

是否有 python/pandas 等价物?

【问题讨论】:

  • Sphinx 非常适合这项工作
  • Sphinx 是正确的答案,但我不禁要注意,roxygen2 是基于Doxygen,而 Doxygen 可以在 Python 上工作。这意味着另一个可能的答案是 Doxygen。
  • 请注意“要求我们推荐或查找书籍、工具、软件库、教程或其他场外资源的问题对于 Stack Overflow 来说是题外话,因为它们往往会吸引固执己见的答案和垃圾邮件。”但是,我不会投票结束这个问题,因为我认为可能不会“吸引固执己见的答案和垃圾邮件”。

标签: python roxygen2


【解决方案1】:

您可以使用sphinx,它可以解析您的源代码并从函数文档字符串生成模块文档。

具体来说,autodoc 功能:http://sphinx-doc.org/ext/autodoc.html

【讨论】:

    猜你喜欢
    • 2011-03-20
    • 2019-02-20
    • 2010-12-01
    • 2015-09-15
    • 1970-01-01
    • 1970-01-01
    • 2010-09-30
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多