Можно ли генерировать документацию docfx из нескольких репозиториев?

У меня есть несколько документов docfx в разных репозиториях. Как я могу объединить эту документацию в один проект docfx, содержащий несколько других?

Использование перекрестной ссылки docfx между проектами не решило мою проблему, поскольку оно просто связывает меня между проектами, но не объединяет.


person T.Harms    schedule 14.08.2019    source источник


Ответы (1)


Возможно, это не лучший способ, но я сделал это с конвейерами сборки/выпуска Azure DevOps. Документация по API не использовалась, поэтому я не могу сказать, сработает ли это для этого. Для чего это стоит:

Предполагая, что у каждого репо есть свои файлы и изображения Markdown...

Создайте конвейер сборки для каждого репо, который публикует его содержимое как артефакт.

Создайте конвейер выпуска...

введите здесь описание изображения

...который загружает каждый артефакт в одно место.

введите здесь описание изображения

DocFx предоставляет задачу конвейера выпуска. Добавьте это в конвейер выпуска.

Создайте универсальный docfx.json в центральном месте. Включите пути к каждому из загруженных артефактов.

Направьте задачу конвейера выпуска DocFx на файл docfx.json.

Чтобы применить пользовательский шаблон, создайте репозиторий для шаблона и выполните те же действия: опубликуйте его как артефакт, загрузите его с конвейером выпуска и укажите каталог с расширением docfx.json.

person hcdocs    schedule 14.08.2019
comment
Это здорово, шаг за шагом, у вас есть пример того, как указать docfx.json на загруженные артефакты? Это мой не может их найти. - person Jade; 28.10.2020