Телеграмм чат группы technicalwriters страница 2929

Всем привет! начал знакомство со сфинкосм. Но чего-то по мануалам из инета, докстринги не попадают в документацию при генерации. В чем может быть причина? Экстейншей подключен. Название классов в доку попадают, но только тупо списком, без подробностей.

источник

15:03пожаловаться #4

КК

Кирилл Кулаков... in technicalwriters

index.rst

источник

15:04пожаловаться #5

КК

Кирилл Кулаков... in technicalwriters

conf.py

источник

15:04пожаловаться #6

КК

Кирилл Кулаков... in technicalwriters

Вот так выглядит один из файлов после автогенерации

источник

15:06пожаловаться #7

Sofia Yemelianova in technicalwriters

Кирилл Кулаков

index.rst

У вас toctree подсвечивается как комментарий (зелёным). Вставьте пустую строку перед ним. А перед modules, наоборот, слишком много пустых строк, нужна всего одна. Надеюсь, поможет.

источник

15:31пожаловаться #8

КК

Кирилл Кулаков... in technicalwriters

Благодарю за подсказку.) Но нет, не помогло. Получилось сгенерировать с докстрингом один класс, но другие пока не хотят. Продолжаю копать, почему)

источник

15:50пожаловаться #9

КК

Кирилл Кулаков... in technicalwriters

autodoc ругается на импорты модулей которых нет в папках, задумка собственно как раз не тянуть всю систему за собой. Как можно отключить чтоб autodoc не пробовал import и from... вызывать? А только из имеющихся файлов в брал классы с докстрингами?

источник

16:18пожаловаться #10

КК

Кирилл Кулаков... in technicalwriters

Или это не влияет?

источник

16:19пожаловаться #11

Sofia Yemelianova in technicalwriters

🤷‍♀

источник

17:09пожаловаться #12

2021 January 10

AVDR in technicalwriters

Джунский вопрос: чем, кроме ворда, можно оформлять документацию по ГОСТам? Присматриваюсь к латеху, но возможно, есть еще варианты?

источник

11:10пожаловаться #13

AVDR in technicalwriters

Просто когда над одним документом в ворде работает 3-5 человек, файл превращается в умиральную яму с дымом, гвоздями, змеями и невидимыми косяками в форматировании, которые хрен отследишь.

источник

11:11пожаловаться #14

AVDR in technicalwriters

ОСОБЕННО РАМКИ

источник

11:11пожаловаться #15

Elena in technicalwriters

Я не пишу по ГОСТам, но поддерживаю идею с TeX. Для совместной работы есть overleaf. Он платный, но того стоит

источник

11:19пожаловаться #16

Eduard Tibet in technicalwriters

AVDR

Есть вариант DocBook/XML 5 (5.1). Одна компания даже сделала и поддерживает XSL:FO стили для ГОСТа. Тут: https://bitbucket.org/Lab50/espd-docbook5/ Но для этого нужно условие - вы должны понимать, что такое XML/XSL и как с ним работать, а также иметь графический редактор DocBook/XML (например, Oxygen или XMLMind).

источник

11:38пожаловаться #17

Eduard Tibet in technicalwriters

AVDR

ОСОБЕННО РАМКИ

Проблема с рамками решается просто - это слой выделен на уровень оформления. Когда автор пишет, он не думает о рамках совсем. В этом и состоит принцип разделения содержание и оформления.

источник

11:39пожаловаться #18

Fagor in technicalwriters

AVDR

Латех, md, асидок. Выберайте, но все равно. На самом деле вам нужен сборщик типа pandoc с форматированием под Гост. Мелькал тут про сборку в госты, скрип на питоне. Лежит гитхабе. Сейчас просто не найду ссылку. Кто то откликнется, чей он там. По описанию что нужно.

источник

11:39пожаловаться #19

Александр Мокрушин... in technicalwriters

AVDR

Погуглите gostdown. Набор библиотек, которые из маркдауна с помощью pandoc создают docx по ГОСТу

источник

11:45пожаловаться #20