Come generare documentazione per altri progetti all'interno soluzione utilizzando DocFx

Question

Sto usando DocFx per generare automaticamente la documentazione in Visual Studio 2015.

Per le Getting Started istruzioni, ho aggiunto un vuoto ASP.NET 4 Web Application e usato il Nuget Console per installare il pacchetto di build DocFx (ad es. Install-Package docfx.msbuild). Ho costruito il sito e ha generato la documentazione per il codice all'interno del progetto.

Mi chiedevo come configurare docfx.json per ottenere DocFx per documentare il codice in altri progetti all'interno della soluzione.

Answer 1

In docfx.json, c'è una serie di metadata. L'esempio metadata ha un oggetto src con le proprietà files e exclude.

Per indicare un altro progetto nella soluzione, aggiungere una proprietà cwd a metadata e modificare le cartelle (ad esempio "../un altro.Project").

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