Использование docfx.console не в состоянии генерировать документацию - PullRequest
Новая
       11

Использование docfx.console не в состоянии генерировать документацию

0 голосов
/ 10 июня 2018

Я установил docfx.console через менеджер пакетов nuget (visual studios 2017 15.7.3) в тестовый проект.Мой проект - библиотека .net с единичным классом с небольшим количеством XML-документации.Когда я собираю проект, он создает файл _site с файлом .html, но без документации.Он также генерирует папку api, apidoc и статьи и файл docfx.json.

Проект выдает предупреждение: невозможно найти ни toc.yml, ни toc.md внутри obj / api /.Убедитесь, что файл включен в конфигурационный файл docfx.json!

Я обнаружил несколько похожих проблем в github, которые посоветовали установить для моей версии Visual Studio 2015, но это решение не работает с docfx.console.насколько я могу судить.Кто-нибудь знает, как я мог бы исправить эту проблему?Спасибо

1 Ответ

0 голосов
/ 01 августа 2018

Я также наткнулся на эту проблему, когда документировал существующее решение VB.net.Не зная, как выглядит ваш файл docfx.json или написана ли ваша библиотека .NET на C # или VB.net, я могу только дать ответ, который устранил мою проблему и, возможно, поможет с вашей.

Для меняпри установке docfx через nuget файл docfx.json по умолчанию используется с проектами C #, а не с проектами VB.Net.

Я легко исправил это, изменив файл docfx.json и изменив файл метаданных.расширение источника для поиска * .vbproj: 

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