Wie Dokumentation für andere Projekte in Lösung erzeugen DocFx mit

Question

I DocFx bin mit automatisch Dokumentation 2015

Per die Getting Started Anweisungen in Visual Studio zu erzeugen, ich ein leer ASP.NET 4 Web Application hinzugefügt und verwendet, um die Nuget Konsole zur Installation des DocFx-Build-Pakets (z. B. Install-Package docfx.msbuild). Ich baute die Site und es erzeugte Dokumentation für Code innerhalb des Projekts.

Ich fragte mich, wie man docfx.json konfigurieren, um DocFx Dokumentcode in anderen Projekten innerhalb der Lösung zu erhalten.

Answer 1

In docfx.json gibt es eine Reihe von metadata. Das Beispiel metadata hat ein src Objekt mit files und exclude Eigenschaften.

Um auf ein anderes Projekt in Ihrer Lösung zu verweisen, fügen Sie eine cwd-Eigenschaft zu hinzu und ändern Sie Ordner (d. H. "../Another.Project").

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