Как разместить документацию по классам и всем их методам на одной странице в первой документации Sphinx. ⇐ Python
-
Anonymous
Как разместить документацию по классам и всем их методам на одной странице в первой документации Sphinx.
Я пытаюсь документировать классы и их методы на одной странице, но получаю либо
[*]Только строка документации классов, но не документация их методов вообще.
или
[*]Классы и их методы на отдельных страницах.
Структура документации, которой я следую, следующая:
В index.rst я использую следующее
.. toctree:: :максглубина: 2 :caption: Содержание: краткий_документ Затем в brief_doc.rst я использую что-то вроде этого:
Краткая документация ==================== .. автосводка:: :toctree: незавершенные работы :шаблон: класс.первый Класс_1 Класс_2 Можно ли автоматически извлекать все методы этих классов и документировать их на отдельных страницах (т. е., например, Class_1 и все его методы на одной странице)
Я пытаюсь документировать классы и их методы на одной странице, но получаю либо
[*]Только строка документации классов, но не документация их методов вообще.
или
[*]Классы и их методы на отдельных страницах.
Структура документации, которой я следую, следующая:
В index.rst я использую следующее
.. toctree:: :максглубина: 2 :caption: Содержание: краткий_документ Затем в brief_doc.rst я использую что-то вроде этого:
Краткая документация ==================== .. автосводка:: :toctree: незавершенные работы :шаблон: класс.первый Класс_1 Класс_2 Можно ли автоматически извлекать все методы этих классов и документировать их на отдельных страницах (т. е., например, Class_1 и все его методы на одной странице)
