Где лучше разместить документацию к проекту на github?

@6sful · Регистрация: 03.05.2020

Студворк — интернет-сервис помощи студентам

Привет
Сгенерировал документацию для проекта в doxygen, хочу закинуть на github pages. Вопрос: как это сделать логичнее и правильнее?
Создать папку "documentation" в репозитории и пихнуть сгенерированные файлы документации (.html, .css, картинки) в неё? Или может создать отдельный репозиторий под документацию и на его основе создать страницу?

@Rius · 07.09.2022, 16:55

Сообщение от 6sful

Создать папку "documentation" в репозитории и пихнуть сгенерированные файлы документации (.html, .css, картинки) в неё?

Ни в коем случае. Основная ветвь в репозитории исходного кода должна содержать только исходный код. Автогенерируемым файлам там не место.
В отдельной orphan ветви можно было бы, это предлагается для github pages и wiki страниц.

Сообщение от 6sful

Или может создать отдельный репозиторий под документацию и на его основе создать страницу?

Это.
Позволит отделить мух от котлет.

Новые блоги и статьи Все статьи Все блоги /
Ритм жизни kumehtar 27.02.2026 Иногда приходится жить в ритме, где дел становится всё больше, а вовлечения в происходящее — всё меньше. Плотный график не даёт вниманию закрепиться ни на одном событии. Утро начинается с быстрых,. . .	SDL3 для Web (WebAssembly): Сборка SDL3 и Box2D из исходников с помощью CMake и Emscripten 8Observer8 27.02.2026 Недавно вышла версия 3. 4. 2 библиотеки SDL3. На странице официальной релиза доступны исходники, готовые DLL (для x86, x64, arm64), а также библиотеки для разработки под Android, MinGW и Visual Studio. . . .	SDL3 для Web (WebAssembly): Реализация движения на Box2D v3 - трение и коллизии с повёрнутыми стенами 8Observer8 20.02.2026 Содержание блога Box2D позволяет легко создать главного героя, который не проходит сквозь стены и перемещается с заданным трением о препятствия, которые можно располагать под углом, как верхнее. . .	Конвертировать закладки radiotray-ng в m3u-плейлист damix 19.02.2026 Это можно сделать скриптом для PowerShell. Использование . \СonvertRadiotrayToM3U. ps1 <path_to_bookmarks. json> Рядом с файлом bookmarks. json появится файл bookmarks. m3u с результатом. # Check if. . .
Семь CDC на одном интерфейсе: 5 U[S]ARTов, 1 CAN и 1 SSI Eddy_Em 18.02.2026 Постепенно допиливаю свою "многоинтерфейсную плату". Выглядит вот так: https:/ / www. cyberforum. ru/ blog_attachment. php?attachmentid=11617&stc=1&d=1771445347 Основана на STM32F303RBT6. На борту пять. . .	Камера Toupcam IUA500KMA Eddy_Em 12.02.2026 Т. к. у всяких "хикроботов" слишком уж мелкий пиксель, для подсмотра в ESPriF они вообще плохо годятся: уже 14 величину можно рассмотреть еле-еле лишь на экспозициях под 3 секунды (а то и больше),. . .	И ясному Солнцу zbw 12.02.2026 И ясному Солнцу, и светлой Луне. В мире покоя нет и люди не могут жить в тишине. А жить им немного лет.	«Знание-Сила» zbw 12.02.2026 «Знание-Сила» «Время-Деньги» «Деньги -Пуля»

@6sful 2 / 2 / 0 Регистрация: 03.05.2020 Сообщений: 33

	Где лучше разместить документацию к проекту на github? 07.09.2022, 12:27. Показов 857. Ответов 1 Метки doxygen, git, github, документация (Все метки) Привет Сгенерировал документацию для проекта в doxygen, хочу закинуть на github pages. Вопрос: как это сделать логичнее и правильнее? Создать папку "documentation" в репозитории и пихнуть сгенерированные файлы документации (.html, .css, картинки) в неё? Или может создать отдельный репозиторий под документацию и на его основе создать страницу? 0

Где лучше разместить документацию к проекту на github?

Решение