Size: a a a

DocOps-сообщество

2021 May 14

ДЮ

Дарья Юсова... in DocOps-сообщество
Всем привет. Помогите, пожалуйста, с проблемой. Я только начинаю разбираться в инструментах и столкнулась с тем, что Read the Docs не собирает сайты с невстроенными темами. У меня всегда выходит ошибка: "no theme named 'sphinx_material' found (missing theme.conf?)" При этом тема установлена,  theme.conf есть. В файле conf.py все прописано, так как сказано в ридми к конкретной теме (пробовала несколько разных). Например, для темы sphinx_material: html_theme = 'sphinx_material'
html_theme_path = ['c:\Program Files\Python38\Lib\site-packages\sphinx_material\sphinx_material'] Читала на разных форумах, как справиться - но ничего не помогает. Заранее спасибо и извините за глупые вопросы.
источник

AV

Alexandr Varyanik in DocOps-сообщество
да у нас внутренняя поделка. и там генерация только от части.
источник

AV

Alexandr Varyanik in DocOps-сообщество
модель данных мы руками пишем, генерируется код самих контроллеров. не совсем тоже что и vaadin.
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
да не.. vaadin.. в данном случае рассматривается как возможность не писать отдельный front... архитектура как бы немного упрощается в том смысле, что не надо писать контроллеры, и не надо кодогенерировать, по крайней мере в части взаимодействия фронта и бэка
источник

M

Maeg in DocOps-сообщество
conf.py, кажется, не надо полный путь писать.
В разделе Path setup  
import sphinx_rtd_theme
В extensions
extensions = ['sphinx_rtd_theme', ]
И в раздел html_theme = ''sphinx_rtd_theme'
источник

ДЮ

Дарья Юсова... in DocOps-сообщество
Спасибо. Кажется, я пыталась прописать подобные параметры - не прокатило. Но я попробую вечером сделать так, как вы указали.
источник
2021 May 15

AN

Andrew Nilove 💔 in DocOps-сообщество
не надо писать контроллеры и кодогенерировать. Мне нравится. Конечно погуглю, но посоветуйте толковую статью про опыт применения vaadin.🙏🏻
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Коллега сделал такой бойлер-плейт проект, включая пирамиду тестирования. Сборка, правда не на GH Actions, а на Jenkins, но разница небольшая. https://github.com/inponomarev/vaadin-celesta-springboot-template
источник
2021 May 17

J

Jonny Cuba in DocOps-сообщество
Коллеги, а кто может подсказать по опыту, для техдокументации что лучше выбрать rst или markdown?
источник

RG

Ramil G in DocOps-сообщество
По опыту хорошо заходит asciidoc
источник

J

Jonny Cuba in DocOps-сообщество
Спасибо, посмотрю.
источник

NV

Nick Volynkin in DocOps-сообщество
Это очень субъективно. И ещё есть asciidoc, ага. И для markdown очень много разных инструментов.
источник

ML

Maksim Lapshin in DocOps-сообщество
Вообще меня слегка пугает то, что все эти языки они про разметку вместо структуры
источник

ML

Maksim Lapshin in DocOps-сообщество
Те вытащить из документа «такое то описание такой-то фичи» нетривиально
источник

RG

Ramil G in DocOps-сообщество
Кстати, да. Тут проскакивал бойлерплейт с хорошей структурой.
источник

RG

Ramil G in DocOps-сообщество
Со всей цепочкой требований, описаниями api и тестами… о да
источник

J

Jonny Cuba in DocOps-сообщество
Вот о наличии подводных камней и хотелось бы услышать)
источник

NV

Nick Volynkin in DocOps-сообщество
Расскажи подробнее, какую задачу решаешь. Какие выходные форматы нужны, какие к ним требования? Нужно ли документировать код? Генерировать документацию прямо из кода? Переводить доки?
источник

VI

Vladimir Izmalkov in DocOps-сообщество
Есть ли большие и сложные таблицы? ;D
источник

J

Jonny Cuba in DocOps-сообщество
Word и pdf по Гост, сайт, api, javadoc,перевод пока не нужен. Плюс "поженить" это с конфлюенс и джирой
источник