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

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

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

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

9
docfx documentation-generation

2 ответов

на docfx.в JSON есть массив metadata. Пример metadata есть src объект files и exclude свойства.

чтобы указать на другой проект в решении, добавьте cwd свойство metadata и изменить папки (т. е. "../Другой.Проект.)"

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

12

это работает для меня.

структура каталогов

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

docfx.в JSON содержание cwd и src - это синонимы одного и того же свойства

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