如何使用DocFx为解决方案中的其他项目生成文档

Question

我正在使用DocFx在Visual Studio 2015中自动生成文档。

根据Getting Started说明，我添加了一个空的ASP.NET 4 Web应用程序，并使用Nuget控制台安装DocFx构建包（例如Install-Package docfx.msbuild）。我构建了网站，它为项目中的代码生成了文档。

我想知道如何配置docfx.json以使DocFx在解决方案中的其他项目中记录代码。

Answer 1

在docfx.json中，有一个metadata数组。示例metadata有一个src对象与files和exclude属性。

要指向解决方案中的另一个项目，请将cwd属性添加到metadata并更改文件夹（即“../Another.Project”）。

{
  "metadata": [
    {
      "src": [
        {
          "files": [ "**/*.csproj" ],
          "exclude": [ "**/bin/**", "**/obj/**", "_site/**" ],
          "cwd": "../Another.Project"
        }
      ],
      "dest": "obj/api"
    }
  ],
  "build": ...
}

Answer 2

这对我有用。

目录结构

+---ClassLibrary
|   \---ClassLibrary.csproj
\---DocFxProject
    \---docfx.json

docfx.json目录cwd和src是同属性的同义词

{
  "metadata":
  [ 
    {
      "src":
      [
        {
          "files": [ "**/ClassLibrary.csproj" ],
          "src": "..",
          "exclude": [ "**/obj/**", "**/bin/**" ]
        } 
      ],
      "dest": "obj/api"
    }
  ],
  "build": { ... }
}