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

Question

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

Getting Started согласно инструкции, я добавил пустой ASP.NET 4 веб-приложения и использовать 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": ... }