使用 docfx.console 无法生成文档答案

【问题标题】：Using docfx.console fails to generate documentation使用 docfx.console 无法生成文档
【发布时间】：2018-11-19 14:38:27
【问题描述】：

我通过 nuget 包管理器 (visual studios 2017 15.7.3) 将 docfx.console 安装到一个测试项目中。我的项目是一个 .net 库，它有一个带有一些 xml 文档的单一类。当我构建项目时，它会创建一个带有 .html 文件但没有文档的 _site 文件。它还生成一个 api、apidoc 和文章文件夹以及一个 docfx.json 文件。

项目抛出警告：无法在 obj/api/ 中找到 toc.yml 或 toc.md。确保该文件包含在配置文件 docfx.json 中！

我在 github 中发现了一些类似的问题，建议将我的 Visual Studio 版本设置为 2015，但是据我所知，此解决方案似乎不适用于 docfx.console。有谁知道我如何能够纠正这个问题？谢谢

【问题讨论】：

github.com/docascode/docfx-seed 显然他们有一个示例项目展示如何在 GitHub 上开始。
我会重新阅读这些说明，但我相信我正确地设置了我的项目。如果我的理解是正确的，有多种方法可以安装和运行docfx。我试图使用集成到视觉工作室的版本（dotnet.github.io/docfx/tutorial/docfx_getting_started.html 上的#3）。我没有忽略有关如何开始的说明。我的设置有问题，可能是我的错误，也可能是docfx中的错误。

标签： visual-studio docfx

【解决方案1】：

我在记录现有的 VB.net 解决方案时也偶然发现了这个问题。在不知道您的 docfx.json 文件是什么样子或您的 .NET 库是用 C# 还是 VB.net 编写的情况下，我只能提供一个解决了我的问题的答案，也许会对您的问题有所帮助。

对我来说，通过 nuget 安装 docfx 时，docfx.json 文件默认设置为用于 C# 项目而不是 VB.Net 项目。

我通过修改 docfx.json 文件并更改元数据文件源扩展名以搜索 *.vbproj 轻松解决了这个问题：

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

【讨论】：

由于我安装 DocFX 生成的元数据文件没有 cwd 设置，我假设你是手动添加的。不管它到达那里，我发现它是必不可少的，除非您的源代码位于名为 /src 的目录中，这对于 VB 或 C# 项目来说是非标准的。
这让我更进一步，但我的目录是空的，. api 文档虽然存在。有什么想法吗？