pdoc 和 pdoc3 有什么区别?

问题描述 投票:0回答:1

我发现了 pdoc 文档生成器的两个分支 pdocGitHub)和pdoc3GitHub)。从 比较提交图,这些似乎在 2018 年中期就分裂了,但是 也许稍后,或者也许两者之间有一些交叉的提交。 我看到的差异是:

  • pdoc:

    • PyPI:第 1 次发布 2013-08-09; v14.4.0 发布2024-01-18
    • Github:48 个贡献者,2.6k 人使用,189 个分叉,1.8k 人加星标
    • 去年适度的提交活动
    • 托管在 GitHub 个人帐户下
  • pdoc3:

    • PyPI:第 1 版 2019-01-25; v0.10.0 发布2021-08-03
    • Github:64 个贡献者,3.8k 人使用,143 个分叉,1.1k 人加星标
    • 过去一年半的提交活动很少
    • 托管在 GitHub 组织下,但只有一名成员

从发行版来看,pdoc3 似乎是 pdoc 的一个分支,但我看不到 关于它为什么分叉或者有什么区别的任何解释。鉴于, 而且提交速度较慢,在我看来令人惊讶的是它有更多 “用户”(我相信这是带有

requirements.txt
引用的项目 它)而不是 pdoc。

无论如何,我不一定需要为什么拆分的详细信息 发生了,但我想知道 pdoc3 提供了哪些功能 pdoc 不,反之亦然,以及与制作相关的任何其他内容 两者之间选择。

注意:要求任何人推荐其中之一,我对此类建议也不感兴趣。我只对有助于我自己做出决定的“事实”感兴趣。 (对于不同的项目,这个决定可能会有所不同。)

python documentation-generation
1个回答
0
投票

鉴于提交频率更高,

    pdoc
  • 似乎

    需要投入更多维护工作。这不一定有意义;对此持怀疑态度。 pdoc3 支持文档字符串的附加

  • #:
  • 注释语法

    pdoc3 支持

    使用
  • __pdoc__
  • 覆盖文档字符串

    。这已从 1.0.0 版本 (2021-01-19) 的 pdoc 中删除,因为它“很少需要”。

    pdoc3 可以生成 PDF 和 HTML 文档; pdoc 仅生成 HTML。

© www.soinside.com 2019 - 2024. All rights reserved.