Size: a a a

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

2020 September 11

PV

Pavel Vrukhin in DocOps-сообщество
Александр Мокрушин
Всем привет!

Помогите, пожалуйста, разобраться, как подключить latex-шаблон к проекту sphinx?

Я скачал TEX-файл и пытался обратиться к нему в conf.py через параметры: 'latex_theme', 'latex_theme_path' и 'latex_additional_files'. Но ничего не получилось.

В документации sphinx вижу, что  latex-шаблон нельзя подключить аналогично HTML-шаблону.
Нужно объявить documentclass и вручную добавлять строки из TEX-файла в параметр 'latex_elements'?
Была необходимость внести небольшие правки в преамбулу генерируемого tex-файла. Также не нашел информации о подключении шаблона аналогично html. В итоге остановился на добавлении нужных строк в преамбулу через параметр latex_elements (https://pastebin.com/KwJg0CLz).
источник

KC

Kseniya Chudakova in DocOps-сообщество
Подскажите, какие метрики документации вы отслеживаете? Как инструменты для этого используете? Навеяно: https://habr.com/ru/company/yandex/blog/443900/
источник

А

Александр Мокрушин... in DocOps-сообщество
Pavel Vrukhin
Была необходимость внести небольшие правки в преамбулу генерируемого tex-файла. Также не нашел информации о подключении шаблона аналогично html. В итоге остановился на добавлении нужных строк в преамбулу через параметр latex_elements (https://pastebin.com/KwJg0CLz).
Павел, спасибо
источник

MM

Maxim Markelow in DocOps-сообщество
Vladimir Troitsky
Добрый день! Не мог бы кто-нибудь подсказать инструмент а-ля Гугл Формы для создания простых алгоритмических инструкций? Типа "Диагностика автомобиля 101: это руль, он крутится? - да/нет" и дальше по веткам...
SurveyStudio. Там можно делать переходы. "Если ответ А, перейти на вопрос 2, если ответ Б, то перейти на вопрос 3".
источник
2020 September 14

VS

Vadim Smelyanskiy in DocOps-сообщество
источник

H

Hartmann in DocOps-сообщество
Какие дерзкие, а. :)
источник
2020 September 16

SP

Sergey Protsenko in DocOps-сообщество
коллеги, кто-либо сталкивался с автоматической генерацией сниппетов (примеров кода на разных ЯП) для документации АРІ? хотелось бы максимально автоматизировать этот процесс. На выходе хочу получить документацию к API в виде: описание ресурса, параметров, пример запроса/ответа, примеры кода на основных яп, и это все на своем сайте.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Sergey Protsenko
коллеги, кто-либо сталкивался с автоматической генерацией сниппетов (примеров кода на разных ЯП) для документации АРІ? хотелось бы максимально автоматизировать этот процесс. На выходе хочу получить документацию к API в виде: описание ресурса, параметров, пример запроса/ответа, примеры кода на основных яп, и это все на своем сайте.
Если нужны сниппеты именно работы с API, то это умеет Postman

https://learning.postman.com/docs/developer/code-generators/
источник

SP

Sergey Protsenko in DocOps-сообщество
да, но постман это делает на своей стороне и копировать вручную или ссылаться на документацию по коллекции не хотелось бы. Хотелось бы иметь аналогичный инструмент у себя в документации
источник

SP

Sergey Protsenko in DocOps-сообщество
в данном контексте интересует сам сервис генерации этих сниппетов
источник

SP

Sergey Protsenko in DocOps-сообщество
которому можно скормить запрос или в идеале прикрутить к openAPI спецификации
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Sergey Protsenko
да, но постман это делает на своей стороне и копировать вручную или ссылаться на документацию по коллекции не хотелось бы. Хотелось бы иметь аналогичный инструмент у себя в документации
Что имеется в виду под "на своей стороне"?

В статье есть ссылка на исходники
https://github.com/postmanlabs/postman-code-generators
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Sergey Protsenko
которому можно скормить запрос или в идеале прикрутить к openAPI спецификации
Первое по запросу "openapi generator", пользуюсь для TypeScript'а, удобная штука
https://github.com/OpenAPITools/openapi-generator

На выходе не совсем сниппеты, а скорее полный клиентский код, но чего-то похожего можно добиться конфигами
источник

DB

Dima Boger in DocOps-сообщество
Мы дописывали openapi-генератор для таких штук
источник

DB

Dima Boger in DocOps-сообщество
redoc умеет в примеры, по-моему:
https://github.com/cdwv/oas3-api-snippet-enricher
источник

DB

Dima Boger in DocOps-сообщество
https://redocly.github.io/redoc/#tag/pet справа примерчики
источник

DB

Dima Boger in DocOps-сообщество
В openapi.yaml это выглядит как кастомный параметр x-codeSamples:
https://github.com/Redocly/redoc/blob/41f81b4d96648fec6bf0c39799c0aa2dded48749/demo/openapi.yaml#L117-L145

Остаётся его просто автоматически/полуавтоматически наполнять, а рендерить его уже умеет redoc
источник

SP

Sergey Protsenko in DocOps-сообщество
Спасибо!
источник
2020 September 17

BN

Baharev Nick in DocOps-сообщество
Привет, коллеги! Подскажите, пожалуйста, такой момент: возможно ли сделать так, чтобы данные из гита (.мд) автоматически подтягивались в конфу? Спасибо.
источник

RG

Roman Gusev in DocOps-сообщество
Возможно
источник