Làm thế nào để tạo ra tài liệu hướng dẫn cho các dự án khác trong giải pháp sử dụng DocFx

Question

Tôi đang sử dụng DocFx để tự động tạo tài liệu trong Visual Studio 2015.

mỗi sự Getting Started hướng dẫn, tôi đã thêm một sản phẩm nào ASP.NET 4 ứng dụng Web và sử dụng NuGet Bàn điều khiển để cài đặt gói xây dựng DocFx (ví dụ: Install-Package docfx.msbuild). Tôi đã xây dựng trang web và nó tạo ra tài liệu cho mã trong dự án.

Tôi đã tự hỏi cách định cấu hình docfx.json để DocFx mã tài liệu trong các dự án khác trong giải pháp.

Answer 1

Trong docfx.json, có một mảng là metadata. Ví dụ metadata có đối tượng src với các thuộc tính files và exclude.

Để trỏ đến một dự án khác trong giải pháp của bạn, hãy thêm thuộc tính cwd vào metadata và thay đổi thư mục (ví dụ: "../Another.Project").

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