在 pdoc 文档中排除装饰器

Question

我想使用

pdoc

从我的 API 文档中排除装饰器。有什么可能的方法可以实现这一目标吗？

举个例子，如果我写：

@xl_func("blah", "blah")
def examples_are_blah()
     print("blah")

我得到以下输出：

我想从文档输出中删除装饰器函数 xl_func，因为它有时包含很多参数，这些参数没有为文档添加任何特定值。

Answer 1

pdoc 的 HTML 输出的装饰器为

<div class="decorator">@cache</div>

隐藏这些内容的最简单方法是使用自定义 CSS 作为自定义模板。您可以在空目录中创建一个

custom.css

文件：

.decorator {
    display: none;
}

然后运行

pdoc --template-directory ./your-template-directory ...

。