Как сгенерировать документацию для других проектов в рамках решения с использованием DocFx

Question

Я использую DocFx для автоматического создания документации в Visual Studio 2015.

В соответствии с инструкциями по началу работы я добавил пустое веб-приложение ASP.NET 4 и использовал консоль Nuget для установки пакета сборки DocFx (например, Install-Package docfx.msbuild). Я создал сайт, и он сгенерировал документацию для кода в рамках проекта.

Мне было интересно, как настроить docfx.json, чтобы DocFx документировал код в других проектах решения.

Answer 1

In docfx.json, there is an array of metadata, Пример metadata имеет src объект с files а также exclude свойства.

To point to another project in your solution, add a cwd собственность на metadata and change folders (ie "../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.jsoncwd а также src являются синонимами одного и того же свойства

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