Ник там админ. Возможно, он знает, кого спросить.

Могу выступить лишь свидетелем отсутствия вреда в этом чате :)

я и там не вредил, там просто дюже все нежные, не уверен даже шо хотел бы вернуться туда

Привет. Коллеги, подскажите пожалуйста, как сделать иерархию страниц в sphinx. Чтоб было как в конфлюенсе. Сейчас toc выводится плоским списком, а это не айс

Если вы про оглавление, то это, кажется, директивой toctree делается и указывается maxdepth
Там тогда вставляются плоские из перечисленных файлов
https://het.as.utexas.edu/HET/Software/Sphinx/markup/toctree.html

кмк, это не совсем то. Но может я ошибаюсь. Смотрите, что нужно. Пусть есть Файлы А, Б, В. Файлы Б и В описывают дочернюю информицю относительно топика файла А. Каждый из трех файлов имеет свое наполнение с заголовками и подзаголовками (пусть будет а1, б1, в1, в1.1 ит.п.) У меня сейчас выводится так:
А
-а1
Б
-б1
В
-в1
-в1.1
причем заголовки прячутся под "плюсики" т.е. не показываются сами по себе, но можно раскрыть.

А мне нужно:
А
-Б
-В

и чтоб под "плюсики" прятались сами файлы

тема alabaster или readthedocs?

В readthedocs можно конфигурировать, что будет в панели навигации: только документы (`titles_only=True`) или подзаголовки тоже (`titles_only=False`, по умолчанию так)

https://github.com/rtfd/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/theme.conf#L13

Чтобы Б и В стали дочерними относительно А, добавьте в А toctree.

..  toctree::
    :maxdepth: 1
    :caption: текст заголовка оглавления

    document_b
    document_c

такое ^^^ оглавление появится прямо в документе и в панели навигации тоже

можно сделать без оглавления в документе, только для панели навигации:

Чтобы Б и В стали дочерними относительно А, добавьте в А toctree.

..  toctree::
    :hidden:

    document_b
    document_c

если что, это в conf.py должно быть

Другими словами, чтобы был многоуровневый TOC, нужно в каждом документе описывать его дочерние документы.

sphinx_rtd_theme

да, точно, rtd это и есть readthedocs )

Оно таки взлетело! Спасибо!!!❤

Всем привет)
Была ли у кого-нибудь необходимость связывать документацию с кодом и апи/тест-кейсами? Если да, то для чего и как вы это сделали?

Вкратце о моем кейсе: работаем в Confluence, хотим прийти к "сквозной документации". Так, чтобы, условно, в конфе ты ознакомился с бизнес-требованиями, потом увидел, где и как это реализовано в коде и там же посмотрел, как тестировали и все ли возможные проблемы покрыли

Тест-кейсы храним в Тестрейле.

В задачах Джиры держим описанием ФТ и НФТ (либо ссылаемся из описания задачи на внешние документы, иногда и в Конфе). К каждой конкретной задаче привязаны конкретные тест-кейсы из Тестрейла (есть спецплагин для интеграции одного с другим).

Код храним и выкладываем через Гитлаб. Бот скидывает в задачу ссылку на мерж-реквест.

При такой организации задача в Джире является входной точкой по конкретной фиче.

Что можно улучшить:
1. Добавить интеграцию Джиры со Слаком, чтобы из задачи можно было переходить в специальный канал в Слаке, где обсуждается только эта ишью.
2. Интегрировать Цеплин с Джирой (знаю, что есть плагин для Инвижена), чтобы из задачи напрямую выходить на дизайн-макеты.