Автоматическая генерация документации c C ++ для проекта GitLab с использованием doxygen

Question

Я работаю в проекте GitLab C ++ и пытаюсь автоматизировать c генерацию документации по коду с использованием Doxygen. Я действительно не знаю, как решить эту проблему.

Можно ли как-то включить его в CMake, чтобы обновлять документацию в проекте каждый раз, когда кто-то его строит?

Или было бы лучше сервер генерирует документацию, когда кто-то нажимает на его код?

Спасибо за вашу помощь!

Answer 1

Да, я думаю, что лучше, чтобы отдельный сервер создавал документацию всякий раз, когда кто-то пихает Если у вас есть учетная запись Travis-CI, вы можете настроить автоматическое c развертывание документации Doxygen в GitLab Wiki.

См. Здесь ссылку на пример Gist для GitHub, но его можно расширить до GitLab. : https://gist.github.com/vidavidorra/548ffbcdae99d752da02

Answer 2

Рассмотрите возможность публикации сгенерированной документации на сайте GitLab Pages (https://docs.gitlab.com/ee/user/project/pages/). После этого вы можете сделать ссылку на нее в вики, чтобы ее было легко найти.

GitLab Wiki хранится в отдельном Git хранилище (https://docs.gitlab.com/ee/user/project/wiki/), поэтому я думаю, что было бы удобнее создать сайт Pages, чем обновлять Wiki Git репо с основного Git репо.