Pdoc 无法识别 Google 风格

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

我正在尝试将 google-style 指令与 pdoc 一起使用,但它在我这边不起作用。 我哪里错了?下面是我的代码。 请帮我。 :)

    def save(a: str, b:str) -> set:
        """
            Do something

            Args:
                a (str): The first parameter.
                b (str): The second parameter.

            Returns:
                Set: The return value. If result has values then Set of string, otherwise empty set.

            """

输出

做某事

Args: a (str):第一个参数。 b (str): 第二个参数。

返回: 设置:返回值。如果结果有值,则集合 字符串,否则为空集。

python documentation google-style-guide pdoc
2个回答
3
投票

您是否告诉 pdoc 将您的文档字符串处理为 Google 风格的文档字符串

使用

pdoc --docformat google ./alf.py
,我得到以下结果:

pdoc screenshot


0
投票

我也有类似的问题 刚刚安装了 pdoc 并尝试输出 .md 文件 使用 pdoc --output-dir 文档 C:/MJ6_SREF/app/services --docformat markdown

doc文件夹包含所有html文件 我做错了什么?

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