问题标签 [docfx]

我正在尝试使用 docfx 为库创建文档。我需要至少使用 2.18.3 版的 docfx，因为我需要创建 pdf 文档。每当我尝试构建解决方案时，docfx 都会抛出一个警告说“没有生成元数据。

我的原始库是 .NET 版本 4.5.2，但我尝试将其升级到版本 4.6 和 4.6.1，以便它与 docfx 版本 2.18.3 兼容。我什至尝试将我的项目更新到 .NET 4.7.2 并将其与最新版本的 docfx 一起使用，但这会引发更多错误。我将 docfx 用作 Visual Studio 2015 的 NuGet 包。

我希望 docfx 在构建项目时不会抛出任何错误或警告，并且我的文档将在 _sites 文件夹中生成。到目前为止，生成的 _sites/api 文件夹是空的，我收到前面提到的警告：“没有生成元数据。”

我在一个 List 类型的属性上使用了 XML 注释。

但是，当我将鼠标悬停在该属性上时，Visual Studio 将其显示为List<T>.

当我使用 docFx 构建文档时，它仍然将注释呈现为List<T>而不是List<ClassXXXX>.

我已经尝试过之前帖子推荐的解决方案，但它不起作用。

这是带有 C# 代码的 XML 注释供您参考：

我可以在 XML 注释中做什么，以便List<ClassXXXX>在智能感知和文档中看到？

谢谢

在尝试使用 Docfx 来记录 C# 项目时，我遇到了一个问题，这可能是因为我自己是个白痴。但是，我已经阅读了docfx 示例，但没有看到任何明显的解决问题的方法。

当我运行时，docfx init -q我没有收到任何错误。当我运行时，docfx docfx.json --serve我也没有收到任何错误，完成后我收到一条Build succeeded. 0 Warnings 0 Errors消息，但是没有生成 html 文件。

它似乎也正确地从我的项目中读取源文件，因为 api 文件夹具有与项目中的类文件同名的 yml 文件。

如何让 docfx 为项目生成适当的 html 文件。--serve 的完整输出docfx docfx.json如下：

我正在使用带有自己主题的docfx 2.43.3（基于default主题）。结果是这样的：http://docs.example.com/。

在这篇文章页面中，http://docs.example.com/articles/add_more.html。

您将如何增加此页面的宽度（所有页面和主块）？

我在不同的存储库中有多个docfx 文档。如何将这些文档合并到一个包含多个其他文档的docfx 项目中？

在项目之间使用docfx交叉引用并没有解决我的问题，因为它只是在项目之间链接我，但没有合并。

我正在使用 docfx 为我的 .Net 项目生成 API 文档。我需要向不同类型的客户展示不同风格的内容。生成元数据时，也会生成 TOC.YML，这很好。但是，在生成 html 文件时，此 TOC 用于在每个 HTML 页面的侧面创建导航栏。问题是对于某些观众，完整的侧边栏不应该可用，而应该只显示自定义 toc.yml 提供的导航。我可以在自定义文件夹中创建一个新的自定义 TOC 并导航到页面，但是当加载 html 页面时（当然）会显示完整生成的 TOC.yml 的导航栏。

阅读文档。创建了自己的 TOC 文件（正在工作），但我没有找到使用自定义 TOC.yml 生成的 iso 的选项。试图排除docfx.json中的toc.yml。

预期的结果是：每个生成的html文件显示的导航栏都应该基于自定义的toc.yml。

我有一个公开许多命令的大类。当我为类创建文档时，方法按字母顺序排序，但我希望它们按功能分组。有没有办法（使用 DocFx 的 Sand Castle Helpfile 构建器）来完成这个？

我的类库中有以下方法，我想从 API 文档中隐藏：

我按照DocFX 教程过滤 API 文档来创建filterConfig.yml。在该文件中，我有以下内容：

但是，该方法仍然出现在我的文档中。

请注意：

• 我在filterConfig.yml中定义了其他过滤器，它们按预期工作，因此文件正在被 DocFX 拾取并正确解析。
• 我使用这个正则表达式测试器测试了正则表达式模式 (^com.contoso.myns.myclass.Create[^.]+$) ，它确实与我要排除的方法的完全限定名称匹配。

任何帮助将不胜感激。

我刚刚开始学习 DocFX。根据其官方指南，我们使用类似于的命令构建内容，docfx docfx.json --serve然后查看生成的站点http://localhost:8080。我的问题是：如果 DocFX 是一个静态网站生成器，为什么它通过网络服务器提供内容？为什么它不只是说单击 index.html 来查看生成的站点？有区别吗？

目前我有一个 Visual Studio 项目，我使用 docfx.console nuget 包来构建文档，一切正常，如预期的那样......在 Windows 上。现在的重点是我想制作一个mcr.microsoft.com/dotnet/core/sdk:3.1基于 linux 镜像的 docker 镜像。并在运行命令的这个 docker 镜像中编译：

给出以下错误

我已经做了一些刺激，我相信我的问题已经基本解决了。运行表明这是file 一个. 并且这些文件不应该在 linux 上使用，而是使用. 确实在运行：console.exePE32 executable (console) Intel 80386 Mono/.Net assembly, for MS Windowsshmono

按预期构建文档。当然，此时我有很多解决方法来正确构建文档，只需从 csproj 中删除docfx.console并使用 docker 命令从命令行手动构建它。

但问题是，我是否也可以通过更改 nuget 包运行 docfx.exe 命令的方式来在 linux 上使用 nuget 包？或者这只能通过实际修复它来实现docfx.console？

ps 以防万一，我使用的 docfx.console 版本是撰写本文时可用的最新版本，即 2.48.1