Size: a a a

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

2021 November 30

NP

Nikolaj Potashnikov in DocOps-сообщество
А наглядное представление должно быть всегда актуально. Или код должен быть всегда актуален наглядному представлению
источник

CL

Constantine Linnick in DocOps-сообщество
источник
2021 December 01

RG

Ramil G in DocOps-сообщество
Кто-то использует logseq? Я сегодня активно изучал, попробовал. В целом удобно, похоже на obsidian. Непонятно предназначение.
источник

LR

Lydia Rudakova in DocOps-сообщество
Всем добрый день! Вопрос про Sphinx - почему при генерации в latex-pdf между разделами могут получаться лишние пустые страницы? Причем только в некоторых разделах, когда форматирование у всех документов одинаковое, и лишних переносов строк нигде не стоит
источник

PV

Pavel Vrukhin in DocOps-сообщество
Скорее всего, у вас документ собирается в "книжном" виде. Попробуйте в .tex файле в директиву \documentclass добавить параметр oneside:
\documentclass[letterpaper,10pt,russian,oneside]
источник

LR

Lydia Rudakova in DocOps-сообщество
Спасибо!
источник
2021 December 02

S

Spelendora in DocOps-сообщество
Утро доброе!

Наша команда хочет завести документацию по проекту по Docs as Code практике.

Ожидается:

Технический писатель пишет доку.
Пушит ее в гит.
Какая-то тузла подхватывает коммит с докой и публикует ее на read-only фронте, который доступен для чтения остальной командой. Наподобии swagger для API.

Можете подсказать опенсорсные тулзы для этого? Или этот подход изначально порочен и лучше доку вести в wiki формате в каком нить outline-wiki?
источник

DB

Dima Boger in DocOps-сообщество
Концепция генерации статического файла из исходников называется static site generator, SSG. Нужно выбрать удобный формат документов — markdown, MDX, RST и из них выбирать поддерживающие генераторы
источник

S

Spelendora in DocOps-сообщество
Принципиальной разницы для меня нет. markdown более популярен, RST приятно читать.

Можете посоветовать для этих 2-х форматов несколько наиболее популярных тулзов?
источник

А

Александр Мокрушин... in DocOps-сообщество
RST - Sphinx
источник

DB

Dima Boger in DocOps-сообщество
Hugo, sphinx, Jekyll
источник

DB

Dima Boger in DocOps-сообщество
Кажется где-то был удобный каталог генераторов с фильтрами, но не смог быстро найти :(
источник

А

Александр Мокрушин... in DocOps-сообщество
источник

S

Spelendora in DocOps-сообщество
Большое вам спасибо, есть что изучать)
источник

RG

Ramil G in DocOps-сообщество
Посмотрите antora. Законченное решение для вашей задачи
источник
2021 December 06

DB

Daniko Basile in DocOps-сообщество
Всем привет. Хочу настроить сфинкс, сделать, чтобы был доступ сразу к нескольким версиям документации, с переключением между ними. Пока только видел живые примеры а статей как это сделать не попадалось. Может кто-то встречал?
источник

AB

Albina Brycheva in DocOps-сообщество
Вау! Это что за инструмент/расширение?
источник

CL

Constantine Linnick in DocOps-сообщество
IntelliJ IDEA
источник

MM

Mikhail Mironov in DocOps-сообщество
А для rst там есть такая фича?
источник

CL

Constantine Linnick in DocOps-сообщество
где там?
источник