Size: a a a

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

2021 June 28

ML

Maksim Lapshin in DocOps-сообщество
Коллеги, кто нибудь стилизовывал вывод grapviz?

Дизайнер рисует красивые картинки, а я пытаюсь донести, что от картинки проку мало, потому как она меняется часто и наличие картинки приведет только к тому, что в схеме будет постоянно что-то неправильное, потому что лень менять.


Но graphviz действительно некрасив.
источник

DB

Dima Boger in DocOps-сообщество
А именно graphviz нужен? Какой-нибудь mermaidjs не подойдёт?
источник

ML

Maksim Lapshin in DocOps-сообщество
мермейд очень плохо раскладывает.

Графвизом легче управлять, делая группы, структуры и предсказуемо раскладывать блоки. Мермейд очень прост на старте, но прыгает как хочет, довольно рандомно
источник

DB

Dima Boger in DocOps-сообщество
В моей практике красивенько всё равно не получалось, но объяснить что не так не могу. Максимум до подобного доводили:
источник

RT

Roman Tsirulnikov in DocOps-сообщество
Там есть стили, цепляются к блокам, например

Approve [shape=cds, label="Approve", color=green, fontcolor=green]
Decline [shape=cds, label="Decline", color=red, fontcolor=red]

node [fontname="helvetica"];
edge [fontname="helvetica"];


у них на сайте есть отдельная дока по стилям
источник
2021 June 29

А

Александр Мокрушин... in DocOps-сообщество
Всем привет!
Посоветуйте, пожалуйста, расширение Sphinx для описания API.

Установил sphinxcontrib.httpdomain, но удобство и собранный результат пока не впечатляют.
источник

A

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

А

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

A

Angela in DocOps-сообщество
это правда только для RESTового OpenAPI
источник

MM

Maxim Markelow in DocOps-сообщество
Всем привет!

Для документации используем mkdocs c material темой, хостим доку на read-the-docs. Хотели себе сделать server-side поиск, по документации вроде все должно работать из коробки без доп. действий. Но по факту все равно работает client-side поиск.

Подскажите, пожалуйста, кто-нибудь уже решал такую же проблему?
источник
2021 June 30

J

Jonny Cuba in DocOps-сообщество
Всем привет! Такая трабла по умолчанию в структуре Sphinx в индексном файле есть вот такая метка genindex (алфавитный указатель), ранее я создал файл с таким названием, оказалось так делать нельзя, это имя зарезервировано в сфинксе, файл я удалил, но теперь эта метка не работает)) Как можно починить? При этом алфавитный указатель с этим именем в html собирается, но на странице содержания -  нети вот такая ошибка при сборке \doc\index.rst:60: WARNING: undefined label: genindex
источник

M

Maeg in DocOps-сообщество
это метки. Отдельно настраиваете toctree, а метки ставите перед заголовком или подзаголовком, они абсолютные:
.. _section_name:
источник

M

Maeg in DocOps-сообщество
У них есть бонус - :ref:`любой текст <section_name>`
источник

J

Jonny Cuba in DocOps-сообщество
я понимаю что метки, а вот эта метка genindex, зарезервирована Sphinx и теперь выглядит вот так
источник

M

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

M

Maeg in DocOps-сообщество
оно?
источник

J

Jonny Cuba in DocOps-сообщество
да оно, но не работает, вот файл есть при сборке
источник

J

Jonny Cuba in DocOps-сообщество
вот делаю так и так
источник

J

Jonny Cuba in DocOps-сообщество
Получаю
источник

J

Jonny Cuba in DocOps-сообщество
источник