【问题标题】:Docfx saying succeeded but no output files are generatedDocfx 说成功但没有生成输出文件
【发布时间】:2019-07-04 17:24:48
【问题描述】:

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

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

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

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

[19-07-04 05:07:47.020]Info:[MetadataCommand.ExtractMetadata]Using msbuild C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Current\Bin as inner compiler.
[19-07-04 05:07:47.302]Info:[MetadataCommand.ExtractMetadata]Loading projects...
[19-07-04 05:07:50.379]Info:[MetadataCommand.ExtractMetadata]'C:/Users/Devvy/Source/Repos/TestProj/TestProj.csproj,C:/Users/Devvy/Source/Repos/TestProj/Display_Output.cs,C:/Users/Devvy/Source/Repos/TestProjException.cs,C:/Users/Devvy/Source/Repos/TestProj_Core.cs,C:/Users/Devvy/Source/Repos/TestProj/Module_Info.cs,C:/Users/Devvy/Source/Repos/TestProj/Opcode_Assembler.cs,C:/Users/Devvy/Source/Repos/TestProj/Opcode_Disassembler.cs,C:/Users/Devvy/Source/Repos/TestProj/Pattern_Tools.cs,C:/Users/Devvy/Source/Repos/TestProj/Payloads.cs,C:/Users/Devvy/Source/Repos/TestProj/Process_Info.cs,C:/Users/Devvy/Source/Repos/TestProj/PtrRemover.cs,C:/Users/Devvy/Source/Repos/TestProj/RopChainGenerator32.cs,C:/Users/Devvy/Source/Repos/TestProj/RopChainGenerator64.cs,C:/Users/Devvy/Source/Repos/TestProj/Thread_Info.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472.AssemblyInfo.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472/TestProj.AssemblyInfo.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472_Lib.AssemblyInfo.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472/TemporaryGeneratedFile_036C0B5B-1481-4323-8D20-8F5ADCB23D92.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472/TemporaryGeneratedFile_5937a670-0e60-4077-877b-f7221da3dda1.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/net472/TemporaryGeneratedFile_E7A71F73-0F8D-4B9B-B56E-8E70B10BC5D3.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Debug/netstandard2.0.AssemblyInfo.cs,C:/Users/Devvy/Source/Repos/TestProj/obj/Release/net472/TestProj.AssemblyInfo.cs' keep up-to-date since '7/4/2019 5:03:14 PM', cached result from 'C:/Users/Devvy/Source/Repos/TestProj/Documentation/api' is used.
[19-07-04 05:07:50.379]Info:[MetadataCommand]Completed Scope:MetadataCommand in 3384.2278 milliseconds.
[19-07-04 05:07:50.379]Info:Completed in 3389.2213 milliseconds


Build succeeded.
    0 Warning(s)
    0 Error(s)

【问题讨论】:

  • 能分享一下你的docfx.json文件吗

标签: c# documentation docfx


【解决方案1】:

Docfx 为我们提供静态代码文档。如果您想正确使用docfx 输出静态网站。您应该按照以下步骤操作;

首先你必须安装docfx。你有很多方法,但我推荐install with choco

choco install docfx -y

那么你必须从 NuGet 添加你的项目docfx 控制台包

Install-Package docfx.console -Version 2.33.0

现在打开你的项目文件夹或任何你想创建的文件夹然后run like that

docfx init 

现在这个答案的最佳部分你必须config you'r project docfx.json file like this

运行后

docfx --serve

我还找到了一个示例项目here

我认为你的问题是你的 docfx 文件配置。

【讨论】:

    猜你喜欢
    • 2018-09-27
    • 2022-11-11
    • 2018-05-24
    • 1970-01-01
    • 2019-07-21
    • 2017-12-18
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多