С Новым годом! Форум программистов, компьютерный форум, киберфорум
Git
Войти
Регистрация
Восстановить пароль
Блоги Сообщество Поиск Заказать работу  
 
Рейтинг 5.00/4: Рейтинг темы: голосов - 4, средняя оценка - 5.00
2 / 2 / 0
Регистрация: 03.05.2020
Сообщений: 33

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

07.09.2022, 12:27. Показов 838. Ответов 1

Студворк — интернет-сервис помощи студентам
Привет
Сгенерировал документацию для проекта в doxygen, хочу закинуть на github pages. Вопрос: как это сделать логичнее и правильнее?
Создать папку "documentation" в репозитории и пихнуть сгенерированные файлы документации (.html, .css, картинки) в неё? Или может создать отдельный репозиторий под документацию и на его основе создать страницу?
0
Лучшие ответы (1)
cpp_developer
Эксперт
20123 / 5690 / 1417
Регистрация: 09.04.2010
Сообщений: 22,546
Блог
07.09.2022, 12:27
Ответы с готовыми решениями:

Где лучше разместить функцию?
Если несколько классов используют одну и ту же функцию, то где следует разместить такую функцию? Создавать специальный класс?

Где лучше разместить блог?
(Извините, если где то обсуждалось. Не нашел) Ситуация такова: есть сайт - site.com.ua (каталог товаров в будущем магазин, сайт с 2004...

Где лучше разместить статью?
Написал хорошую статью на 4000 знаков. Подскажите плиз как лучше поступить для продвижения своего Сайта?: 1) Разместить статью на...

1
Эксперт .NET
 Аватар для Rius
13050 / 7616 / 1664
Регистрация: 25.05.2015
Сообщений: 23,160
Записей в блоге: 14
07.09.2022, 16:55
Лучший ответ Сообщение было отмечено 6sful как решение

Решение

Цитата Сообщение от 6sful Посмотреть сообщение
Создать папку "documentation" в репозитории и пихнуть сгенерированные файлы документации (.html, .css, картинки) в неё?
Ни в коем случае. Основная ветвь в репозитории исходного кода должна содержать только исходный код. Автогенерируемым файлам там не место.
В отдельной orphan ветви можно было бы, это предлагается для github pages и wiki страниц.

Цитата Сообщение от 6sful Посмотреть сообщение
Или может создать отдельный репозиторий под документацию и на его основе создать страницу?
Это.
Позволит отделить мух от котлет.
1
Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.
raxper
Эксперт
30234 / 6612 / 1498
Регистрация: 28.12.2010
Сообщений: 21,154
Блог
07.09.2022, 16:55
Помогаю со студенческими работами здесь

Подскажите где лучше будет разместить рекламу
Есть сайт с бесплатными видео уроками http://uchu24.ru. Зарегистрировался в директе, не знаю куда притулить рекламу чтобы не испортила...

где лучше разместить рекламу от гугла (adsence)
В каждой тебе после первого сообщения? а может где ещё? есть у кого-нибудь опыт?

Где мне лучше разместить .NET Core приложение?
Где мне оптимальнее разместить приложение в стеке .NET Core + PostgreSQL.Особенных требований, кроме оптимальной цены и надёжности...

Где лучше разместить долго выполняющийся код из Form_Load?
Вообщем в Form_Load у меня стоят много запросов на сайт, пока эти запросы не пройдут все форма не откроется, куда поставить эти запросы...

Кто сможет написать документацию по проекту
Помогите пожалуйста, у меня уже написана программа "система учета Тов- мат ценностей", написано на PHP, документация к проекту есть,...


Искать еще темы с ответами

Или воспользуйтесь поиском по форуму:
2
Ответ Создать тему
Новые блоги и статьи
Модель микоризы: классовый агентный подход
anaschu 02.01.2026
Раньше это было два гриба и бактерия. Теперь три гриба, растение. И на уровне агентов добавится между грибами или бактериями взаимодействий. До того я пробовал подход через многомерные массивы,. . .
Учёным и волонтёрам проекта «Einstein@home» удалось обнаружить четыре гамма-лучевых пульсара в джете Млечного Пути
Programma_Boinc 01.01.2026
Учёным и волонтёрам проекта «Einstein@home» удалось обнаружить четыре гамма-лучевых пульсара в джете Млечного Пути Сочетание глобально распределённой вычислительной мощности и инновационных. . .
Советы по крайней бережливости. Внимание, это ОЧЕНЬ длинный пост.
Programma_Boinc 28.12.2025
Советы по крайней бережливости. Внимание, это ОЧЕНЬ длинный пост. Налог на собак: https:/ / **********/ gallery/ V06K53e Финансовый отчет в Excel: https:/ / **********/ gallery/ bKBkQFf Пост отсюда. . .
Кто-нибудь знает, где можно бесплатно получить настольный компьютер или ноутбук? США.
Programma_Boinc 26.12.2025
Нашел на реддите интересную статью под названием Anyone know where to get a free Desktop or Laptop? Ниже её машинный перевод. После долгих разбирательств я наконец-то вернула себе. . .
Thinkpad X220 Tablet — это лучший бюджетный ноутбук для учёбы, точка.
Programma_Boinc 23.12.2025
Рецензия / Мнение/ Перевод Нашел на реддите интересную статью под названием The Thinkpad X220 Tablet is the best budget school laptop period . Ниже её машинный перевод. Thinkpad X220 Tablet —. . .
PhpStorm 2025.3: WSL Terminal всегда стартует в ~
and_y87 14.12.2025
PhpStorm 2025. 3: WSL Terminal всегда стартует в ~ (home), игнорируя директорию проекта Симптом: После обновления до PhpStorm 2025. 3 встроенный терминал WSL открывается в домашней директории. . .
Как объединить две одинаковые БД Access с разными данными
VikBal 11.12.2025
Помогите пожалуйста !! Как объединить 2 одинаковые БД Access с разными данными.
Новый ноутбук
volvo 07.12.2025
Всем привет. По скидке в "черную пятницу" взял себе новый ноутбук Lenovo ThinkBook 16 G7 на Амазоне: Ryzen 5 7533HS 64 Gb DDR5 1Tb NVMe 16" Full HD Display Win11 Pro
Музыка, написанная Искусственным Интеллектом
volvo 04.12.2025
Всем привет. Некоторое время назад меня заинтересовало, что уже умеет ИИ в плане написания музыки для песен, и, собственно, исполнения этих самых песен. Стихов у нас много, уже вышли 4 книги, еще 3. . .
От async/await к виртуальным потокам в Python
IndentationError 23.11.2025
Армин Ронахер поставил под сомнение async/ await. Создатель Flask заявляет: цветные функции - провал, виртуальные потоки - решение. Не threading-динозавры, а новое поколение лёгких потоков. Откат?. . .
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin
Copyright ©2000 - 2026, CyberForum.ru