Size: a a a

Технические писатели

2021 August 31

FM

Fox Mulder in Технические писатели
для Меня adoc нравится тем, что он более богат на разметку
источник

NV

Nick Volynkin in Технические писатели
Примеры тащи )
источник

A

Angela in Технические писатели
нет, не секрет, в основном, нам нужны были две фичи:
- мультирепозитории
- многоуровневая навигация
желательно из коробаса, также более дружелюбный к техписам интерфейс

ещё момент - в будущем понадобится локализация, но не полностью, а частичная, что в сфинксе сделать невозможно

выбирали между хьюго, гэтсби, анторой и ещё что-то было, выбрали антору в итоге
источник

NV

Nick Volynkin in Технические писатели
Частичная это как? Просто часть страниц с переводом и другая часть без него, или что-то иное?
источник

A

Angela in Технические писатели
в сфинксе это всё тоже можно реализовать, но сложнее
и как там мультирепы делать - я не знаю и не нагуглила особо
источник

A

Angela in Технические писатели
да, англ версия более полная
источник

A

Angela in Технические писатели
в анторе все сорсы подключаются в одном ямле, а в сфинксе надо пилить сборку под каждую репу
источник

NV

Nick Volynkin in Технические писатели
Доки Тарантула собираются сейчас из семи репозиториев, часть исходников генерится из кода. Полёт нормальный :)
источник

FM

Fox Mulder in Технические писатели
rst не православный) и не красивый.
источник

ET

Eduard Tibet in Технические писатели
На самом деле сравнение rst и adoc более чем интересно, ибо и то, и другое - сделано для интенсивного использования семантики, но разными людьми и в разных тимах. Первый - в рамках Питона. Второй - для текстовой замены xml-based DocBook.
источник

A

Angela in Технические писатели
не спорю 😅
но дизайн на сфинксе из коробаса устаревший, плюс если не отследишь локализацию, будет местами торчать нативный язык
источник

NV

Nick Volynkin in Технические писатели
Там два варианта: можно каждую репу отдельно, можно просто собрать из одной директории, в которой субмодулями собраны разные репозитории
источник

D

Dmitriy in Технические писатели
rST к XML ближе некуда
источник

ET

Eduard Tibet in Технические писатели
adoc к XML куда ближе, ибо это полный эквивалент DocBook в разрезе семантического словаря.
источник

NV

Nick Volynkin in Технические писатели
О да, дизайн дефолтной темы совсем простой. Тема pandas вот хорошая.
источник

NV

Nick Volynkin in Технические писатели
Субьективщина )
источник

A

Angela in Технические писатели
тоже вариант, но нас вот ещё простота в деплое интересовала для не разработчиков
источник

NV

Nick Volynkin in Технические писатели
А на локализацию можно (и нужно) тесты сделать.
источник

NV

Nick Volynkin in Технические писатели
А что там с деплоем, расскажи?

Вроде же там и там статический сайт.
источник

ET

Eduard Tibet in Технические писатели
Но с другой стороны, для linux kernel выбрали именно rst, хотя у них многие ридми были в DocBook.
источник