A
Да. В точку.
Size: a a a
2017 December 12
A
Вот думаем,может как-то переделать проучится бесплатную,чтобы читало с приватных. )
A
Но тут встал ступор с авторизацией.
A
RradTheDocs идеально подходит для документации.
Вот то,что вы кинули ссылку на стек,так же мой вопрос. Разобрался.
Можно подтягивать документацию по тегам из репозитория.
Т.е. Будет все красиво v1.0 v1.a1 и т.д.
Вот то,что вы кинули ссылку на стек,так же мой вопрос. Разобрался.
Можно подтягивать документацию по тегам из репозитория.
Т.е. Будет все красиво v1.0 v1.a1 и т.д.
NV
Ну да, это для тех возможных читателей, которые не в теме.
Ага, RTD собирает документацию по тегам и последнюю версию, а виджет с версией эти версии показывает. Виджет, насколько я помню, входит в RTD Theme. Его можно переписывать свободно, там шаблоны на Jinja. Во время очередной сборки туда попадают все имеющиеся версии и языки.
Вот исходник: https://github.com/rtfd/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/versions.html
Ага, RTD собирает документацию по тегам и последнюю версию, а виджет с версией эти версии показывает. Виджет, насколько я помню, входит в RTD Theme. Его можно переписывать свободно, там шаблоны на Jinja. Во время очередной сборки туда попадают все имеющиеся версии и языки.
Вот исходник: https://github.com/rtfd/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/versions.html
NV
Мне этот виджет кажется неудобным. Нужно быть знакомым с RTD, чтобы вообще заметить эту мелкую кнопочку внизу экрана. Поэтому я писал свой шаблон, чтобы списки языков и версий были в шапке. Другое дело, что у нас новые версии появляются нечасто, а их список захардкожен. А на RTD он формируется динамически.
NV
У вас сколько вообще версий будет и как часто появляются новые?
EN
RradTheDocs идеально подходит для документации.
Вот то,что вы кинули ссылку на стек,так же мой вопрос. Разобрался.
Можно подтягивать документацию по тегам из репозитория.
Т.е. Будет все красиво v1.0 v1.a1 и т.д.
Вот то,что вы кинули ссылку на стек,так же мой вопрос. Разобрался.
Можно подтягивать документацию по тегам из репозитория.
Т.е. Будет все красиво v1.0 v1.a1 и т.д.
как контент будете переиспользовать? если понадобится внести изменения в несколько версий, придется во всех ветках править одно и то же
NV
@koshatneg
git cherry-pick? )A
Честно, сколько версий и как часто, я не знаю.
Нужно будет у начальника спросить.
А контент, думаю, переиспользоваться не будет.
Задача в том, чтобы можно было просто ознакомиться со старой и новой версией документации.
Обновили приложение наше, подтянули новую документацию. Старую трогать не будем.
Нужно будет у начальника спросить.
А контент, думаю, переиспользоваться не будет.
Задача в том, чтобы можно было просто ознакомиться со старой и новой версией документации.
Обновили приложение наше, подтянули новую документацию. Старую трогать не будем.
NV
Про переиспользование: вы же наверняка бэкпортите исправления багов, хотя бы критичных. Такое бывает и в документации.
NV
А можно узнать, какой продукт у вас, или хотя бы в какой области?
A
Собираемся внедрят на большую часть своих проектов.
А вот какие проекты... Тут уже политика неразглашения.
Сейчас обговорю с начальником, что к чему.
А вот какие проекты... Тут уже политика неразглашения.
Сейчас обговорю с начальником, что к чему.
NV
Кстати, про версии. Думаю, что ещё лучше — не список, а панелька со всеми версиями сразу, где выделена та, которую вы сейчас читаете.
NV
В пример всегда привожу Dwarf Fortress Wiki http://dwarffortresswiki.org/index.php/DF2014:Adamantine
A
Но честно, я тут пока что новичек, вообще в целом в программирование и всем этом.
только пол года как начал работать вообще программистом. Ещё много вещей и не знаю. А тут вопросы про документацию. )
только пол года как начал работать вообще программистом. Ещё много вещей и не знаю. А тут вопросы про документацию. )
A
Сейчас обговорили, сделать акцент на авторизаю через GitLab.
NV
А что вы понимаете под авторизацией через GitLab?
NV
на RTD суть в том, что сервер RTD авторизуется в GitLab на доступ к вашим репозиториям
