В рейтинге участвует:

групп:

каналов:

Виртуальный сервер на SSD - недорого!

Аренда выделенных и виртуальных серверов (VDS/VPS), хостинг, аренда IP-адресов, администрирование, круглосуточная поддержка

qwarta.ru подробнее

Резервное копирование с проверкой на вирусы!!!

Удобный сервис создания резервных копий на любой сервер сети интернет. Отслеживайте изменения, проверяйте на вирусы. Надежно защитите свой бизнес!

go.backupland.com

Выбираете сервер? Любая конфигурация на заказ!

Аренда физических серверов любых конфигураций под любые запросы - 1С бухгалтерия, игровые сервера, нагруженные проекты, интернет-магазины!

qwarta.ru подробнее

Size: a a a

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

929 membersпожаловаться на группу
2021 November 01

NV

Nick Volynkin in DocOps-сообщество
rST+Sphinx это очень хорошо для документации. :)

Вы инструмент для себя выбираете, а не для инженера. Так что тут первичны ваши потребности. А инженеру в общем-то не понадобится Python знать, чтобы пару CLI-утилит запихнуть в CI. Если у него будут вопросы, пускай приходит сюда, мы поможем :)
источник
15:02пожаловаться#1

NV

Nick Volynkin in DocOps-сообщество
Ад — это потому что вы неправильные таблицы использовали, нужны list-table.

То что правила нужно соблюдать — это хорошо, это fail-fast и обеспечивает качество. На маркдауне можно написать исходник с ошибками и не заметить. А если ошибка в исходнике rST, то у вас сборка упадет сразу же и вы узнаете об ошибке.
источник
15:04пожаловаться#2

AB

Albina Brycheva in DocOps-сообщество
а если требуется получать для одной группы продуктов html, для других pdf с полностью настраиваемым шаблоном, то разворачиваются 2 механизма разработки документации или выбирается инструментарий, который более менее (но не идеально) справляется с обеими задачами?
источник
15:07пожаловаться#3

AB

Albina Brycheva in DocOps-сообщество
какой вы редактор rST посоветуете из вашего опыта?
источник
15:08пожаловаться#4

NV

Nick Volynkin in DocOps-сообщество
я пишу в PyCharm и запускаю sphinx-autobuild, чтобы смотреть сразу в браузере на результат работы
источник
15:10пожаловаться#5

NV

Nick Volynkin in DocOps-сообщество
а ещё у нас из каждого пулл-реквеста документация собирается на тестовом окружении, чтобы все могли посмотреть
источник
15:11пожаловаться#6

VS

Vadim Smelyanskiy in DocOps-сообщество
В общем случае я бы согласился.
Но в чём практическая польза конкретно этих правил?)
источник
18:22пожаловаться#7

NV

Nick Volynkin in DocOps-сообщество
Заголовки действительно не самым лучшим образом сделаны, в MD заголовки удобнее. Ну и не нужно сверху и снизу строки из =, достаточно снизу. И она может быть длиннее текста заголовка, чтобы ты мог как-нибудь макросом сразу добавлять строку на 80 символов
источник
18:58пожаловаться#8

L

Lana in DocOps-сообщество
плюсую за list-tables в сфинксе, только ими и делала всегда, очень удобно транспонировать таблицу в список, обновлять проще, видеть всю структуру тоже. Кстати, в asciidoc похожим образом таблицы устроены
источник
21:29пожаловаться#9

D

Denis in DocOps-сообщество
Коллеги, а нет ли у кого примера, как заменить название admonition через css (Sphinx)? Нужно именно стандартные адмонишны использовать, но с другими названиями.
источник
23:25пожаловаться#10

PV

Pavel Vrukhin in DocOps-сообщество
Как раз .. admonition:: и позволяет задать свое название.
https://docutils.sourceforge.io/docs/ref/rst/directives.html#generic-admonition
docutils.sourceforge.io
reStructuredText Directives
источник
23:39пожаловаться#11

D

Denis in DocOps-сообщество
Да, но мне нужно переименовать "системные" hint и error
источник
23:43пожаловаться#12

D

Denis in DocOps-сообщество
Должно делаться через css
источник
23:43пожаловаться#13
2021 November 02

PV

Pavel Vrukhin in DocOps-сообщество
Если только вот такой костылик:

.attention .admonition-title {
   font-size: 0;
}

.attention .admonition-title::before {
   font-size: 1rem;
}

.attention .admonition-title::after {
   content: 'Новый заголовок';
   font-size: 1rem;
}

Это под rtd-theme. Возможно, под вашу тему придется допилить.
источник
00:03пожаловаться#14

D

Denis in DocOps-сообщество
Спасибо. У меня book theme. Ничего не происходит ((
источник
00:18пожаловаться#15

PV

Pavel Vrukhin in DocOps-сообщество
На всякий случай уточню: вы .attention на .hint поменяли?)
источник
00:27пожаловаться#16

D

Denis in DocOps-сообщество
менял. и attention оставлял ради эксперимента
источник
00:28пожаловаться#17

D

Denis in DocOps-сообщество
я обычно такие штуки поиском нахожу в репозитории темы. Но в данном случае ничего не находится вообще. Получается, эти адмонишены откуда-то из самого сфинкса подтягиваются
источник
00:33пожаловаться#18

PV

Pavel Vrukhin in DocOps-сообщество
Да. Скорее всего, это можно еще через шаблонизатор настроить.

Еще один вариант — использовать .. admonition:: с собственным классом и стилизовать его:

.. admonition:: Новый заголовок хинта
   :class: hint-new
   
   Содержимое хинта

А вообще у меня сработал первый вариант на вашей теме. Поковыряйте инспектором в браузере. Что-то упустили, наверное.
источник
00:39пожаловаться#19

D

Denis in DocOps-сообщество
в custom.css же добавляли?
источник
00:41пожаловаться#20