我通过nuget包管理器(visual studio 2017 15.7.3)将docfx.console安装到测试项目中。我的项目是一个.net库,带有一个带有一些xml文档的单数类。当我构建项目时,它会创建一个带有.html文件但没有文档的_site文件。它还会生成api,apidoc和articles文件夹以及docfx.json文件。
项目抛出警告:无法在obj / api /中找到toc.yml或toc.md。确保该文件包含在配置文件docfx.json中!
我在github中发现了一些类似的问题,建议将我的visual studio版本设置为2015,但是就我所知,这个解决方案似乎并不适用于docfx.console。有谁知道我怎么能纠正这个问题?谢谢
答案 0 :(得分: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"
}],