Size: a a a

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

2021 October 04

ME

Maria Ermakovich in DocOps-сообщество
пошарили сегодня в чяте Write the Docs, лучшая документация которую я видела за долгое время: https://archive.org/details/JohnMuirVwSounds
источник

V

Vitaly in DocOps-сообщество
да, годно
работать только с текстом — ограничивать себя сильно
источник

ME

Maria Ermakovich in DocOps-сообщество
и одновременно немного ASMR )
источник
2021 October 05

D

Denis in DocOps-сообщество
Коллеги, подскажите, можно ли как-то использовать inline markup с заменами в Sphinx? Например, "**|substitution|**" Сейчас не заменяется в таком виде
источник

NV

Nick Volynkin in DocOps-сообщество
inline markup должен быть в теле заменяемого блока
источник

D

Denis in DocOps-сообщество
Понятно, спасибо!
источник

LR

Lydia Rudakova in DocOps-сообщество
Вопрос по внутренним ссылкам Sphinx.

Допустим, есть структура документации:
> a
>> a_foo
>>> a_bar
> b
>> b_foo
> c

Я могу, к примеру, из файла b_foo сослаться на файл a_bar? Просто где-то упоминалось, что внутренние ссылки можно размещать либо на разделы того же уровня, либо на уровень ниже. Но не выше.
источник

NV

Nick Volynkin in DocOps-сообщество
Mожно ссылаться куда угодно внутри проекта. Ссылки могут быть абсолютными или относительными, вот точно как на вебе или в файловой системе
источник

NV

Nick Volynkin in DocOps-сообщество
из любого места
:doc:`link to a </a>
:doc:`link to a_foo </a/a_foo>`

из a
:doc:`relative link to a_foo <./a/foo>`
источник

NV

Nick Volynkin in DocOps-сообщество
это если у вас лежит документ a.rst и рядом с ним папка а, в которой a_foo
источник

LR

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

NV

Nick Volynkin in DocOps-сообщество
можно даже использовать путь «наверх»:
из b_foo
:doc:`link to a <../a>`
:doc:`link to a_foo <../a/a_foo>`

но это штука хрупкая
источник

MM

Mikhail Mironov in DocOps-сообщество
Привет всем. У меня на работе хотят помочь с обучением. Могут оплатить наставничество. Знаю, что @Nick_Volynkin консультирует. Как у тебя по загруженности? Получится в ближайшее время этим заняться?

Если нет, то может кто-то в курсе, у кого можно получить консультации по техническому писательству?
источник

NV

Nick Volynkin in DocOps-сообщество
ко мне лучше сразу в личку приходить :)
источник

NV

Nick Volynkin in DocOps-сообщество
но есть ещё и другие прекрасные люди: https://getmentor.dev/#tags:Content/Copy
источник
2021 October 07

VS

Vadim Smelyanskiy in DocOps-сообщество
По техническому писательству @factorized отличные курсы ведёт

documentat.io
источник

AB

Anton Bezkrovny in DocOps-сообщество
Привет!
Подскажите, есть ли для sphinx возможность публикации в Wiki OpenProject?
источник

D

Denis in DocOps-сообщество
Коллеги, подскажите, пожалуйста, pandoc при конвертации docx>rst всегда указывает размеры изображений в дюймах или это как-то настраивается?
источник
2021 October 08

ME

Maria Ermakovich in DocOps-сообщество
Смотрите какое красивое: https://www.notion.so/blog/sharding-postgres-at-notion
Организация информации, картинки, активный залог, ясные предложения
источник

ИЦ

Игорь Цупко... in DocOps-сообщество
IDE для markdown/XML

А тем временем JetBrains что-то готовит:
https://lp.jetbrains.com/stardust-landing/
На лендинге есть ссылка для того, чтобы подписаться на Early Access Program. Верим, надеемся, ждём 😌
источник