文档生成 – DocFX：为多个项目生成API文档

发布时间：2020-12-16 07:44:45 所属栏目：百科来源：网络整理

导读：我正在开发一个在解决方案中有多个项目的项目.我希望能够从外部目录生成文档,以保持应用程序代码文件夹清洁.当我尝试在docfx.json中设置src目录时,它似乎不喜欢绝对路径,也不喜欢相对路径. { "metadata": [{ "src": [{ "files": ["../../../Repos/Wsi.Extran

我正在开发一个在解决方案中有多个项目的项目.我希望能够从外部目录生成文档,以保持应用程序代码文件夹清洁.当我尝试在docfx.json中设置src目录时,它似乎不喜欢绝对路径,也不喜欢相对路径.

{
  "metadata": 
  [{
         "src": 
         [{
               "files": ["../../../Repos/Wsi.Extranet.CommonServices/Wsi.Extranet.CommonServices/**/*.csproj"]
               "exclude": 
               [
                    "**/obj/**","**/bin/**","_site/**"
               ]
        }],"dest": "api"
}],"build": {
"content": [
  {
    "files": [
      "api/**.yml","api/index.md"
    ]
  },{
    "files": [
      "articles/**.md","articles/**/toc.yml","toc.yml","*.md"
    ],"exclude": [
      "obj/**","_site/**"
    ]
  }
],"resource": [
  {
    "files": [
      "images/**"
    ],"overwrite": [
  {
    "files": [
      "apidoc/**.md"
    ],"src":    "../../../Repos/Wsi.Extranet.CommonServices/Wsi.Extranet.CommonServices","dest": "_site","globalMetadataFiles": [],"fileMetadataFiles": [],"template": [
  "default"
],"postProcessors": [],"noLangKeyword": false
 }
}

它说它构建正常,但没有找到任何文件,它搜索的目录保留在当前目录中.

D:tempWsiApiDocsdocfx_project>docfx metadata
Info: Config file docfx.json found,start generating metadata...
Info: No files are found with glob pattern **/*.csproj,excluding
    **/obj/**,**/bin/**,_site/**,under directory "D:tempWsiApiDocsdocfx_project"
Info: Completed executing in 54.0087 milliseconds.


Build succeeded.
    0 Warning(s)
    0 Error(s)

当我尝试将相对路径放在files属性中时,我得到以下内容：

D:tempWsiApiDocsdocfx_project>docfx metadata
Info: Config file docfx.json found,start generating metadata...
Info: No files are found with glob pattern
 ../../../Repos/Wsi.Extranet.CommonServices/Wsi.Extranet.CommonServices/**/*.csproj,excluding **/obj/**,under directory
 "D:tempWsiApiDocsdocfx_project"
**Warning: NOTE that `../` is currently not supported in glob pattern,please use `../` in `src` option instead.**
Info: Completed executing in 48.9621 milliseconds.


Build succeeded with warning.
Warning: NOTE that `../` is currently not supported in glob pattern,please use `../` in `src` option instead.
    1 Warning(s)
    0 Error(s)

所以我的困惑似乎在于如何使用src选项.如果在元数据中使用src,那么似乎我无法指定文件和排除信息.我试图在与元数据相同的级别上使用src属性,但似乎什么也没做.

正如错误所述

../ is currently not supported in glob pattern

文件,排除等使用glob模式.通过src设置基目录：

{
  "metadata": [
    {
      "src": [
        {
          "files": "Repos/Wsi.Extranet.CommonServices/Wsi.Extranet.CommonServices/**.csproj","exclude": [
            "**/obj/**","**/bin/**"
          ],"src": "../../.." // <---- base directory
        }
      ],"dest": "api"
    }
  ],"content": [
    {
      "files": [
        "api/**.yml","api/index.md"
      ]
    }
    // ...
  ]
}

Here是构建多个项目的例子

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!