Travis-CI не публикует документацию на уровне файлов Doxygen - PullRequest
0 голосов
/ 23 мая 2019

У меня есть проект , для которого я создаю документацию Doxygen в задании CI и публикую с использованием github-страниц .

Однако явозникает проблема, при которой документация для файлов (т. е. сгенерированная с помощью команды doxygen's @file ) не загружается - ссылки существуют и файлы существуют в ветке gh-pages, но нажатие на любую ссылку приводит кОшибка 404Например, этот должен привести к этому файлу, но ссылка не работает.

Насколько я могу судить, это потому, что Джекилл игнорирует любой файл, имя которого начинаетсяс подчеркиванием, и это шаблон вывода, который doxygen использует (насколько я могу судить) без способа изменить это.Похоже, чтобы исправить это, вам нужно сказать Джекиллу включить эти файлы, но это пока не работает для меня.

Я пытался

Любой из этих файлов, которые я создаю в основной ветке, кажется, игнорируется в ветви gh-pages, и все, что я создаю в ветви gh-pages, является(как и ожидалось) перезаписано travis.

Как я могу опубликовать эти файлы на веб-странице?

1 Ответ

1 голос
/ 23 мая 2019

Doxygen решает, по умолчанию, как создавать выходные имена файлов на основе используемой ОС.Это приводит к тому, что в системах, не чувствительных к регистру, всегда есть уникальные имена (например, путем замены символа верхнего регистра на знак подчеркивания, за которым следует соответствующий символ в нижнем регистре (символы подчеркивания заменяются на два символа подчеркивания). Для управления этим параметром конфигурации CASE_SENSE_NAMES можно использовать.

Из документации (1.8.15):

CASE_SENSE_NAMES Если для тега CASE_SENSE_NAMES задано значение NO, doxygen будет генерировать имена файлов только в нижнем регистре.буквы. Если задано значение YES, также допускаются заглавные буквы. Это полезно, если у вас есть классы или файлы, имена которых отличаются только регистром, и если ваша файловая система поддерживает имена файлов с учетом регистра.

Windows и Macпользователям рекомендуется установить для этого параметра значение NO.

Значение по умолчанию: системно-зависимое.

...