DocFx生成python文档,无法生成带有@property decorator的属性

2024-10-03 13:30:06 发布

您现在位置:Python中文网/ 问答频道 /正文

我想为Python生成文档。例:

class A:
    def method1(self):
        return 
    
    @property
    def name(self):
        return A._name

目前,Docfx只能为方法“method1”生成文档,而不能为属性“name”生成文档

遵循本教程:https://dotnet.github.io/docfx/tutorial/howto_filter_out_unwanted_apis_attributes.html#2-attribute-filter-rules

之后: docfx.exe元数据--筛选器 但是docfx.json文件没有更改,如示例所示:

{
  "metadata": [
    {
      "src": [
        {
          "files": [
            "src/**.csproj"
          ],
          "exclude": [
            "**/bin/**",
            "**/obj/**"
          ]
        }
      ],
      "dest": "obj/api",
      "filter": "filterConfig.yml"
    }
  ]
}

My filterConfig.yml:

apiRules:
- include:
    uidRegex: ^Root.\to.\repo$
    type: Property

谢谢~


Tags: name文档selfsrcobjreturnymldef