Уведомления

Группа в Telegram: присоединиться | Jabber-конференция сообщества: pythonua@conference.jabber.ru

#1 Март 26, 2018 13:14:32

driveman
Зарегистрирован: 2018-02-28
Сообщения: 17
Репутация: +  1  -
Профиль   Отправить e-mail  

Сократить объем текста при документировании в Sphinx

Доброго времени суток всем.

Как заставить Sphinx выводить в документацию только имена классов, методов, функций и их описания из docstring?

Например, сейчас такой код:

 from collections import namedtuple
class Constants:
    """
    Класс для хранения констант
    """
    Consts = namedtuple('Consts', 'CONST_1, CONST_2')
    consts = Consts(111, 222)
    def print_constants(self):
        """
        Печатает константы
        """
        print(str(Constants.consts.CONST_1))
mc = Constants
mc.print_constants(mc)

Sphinx документирует так:
class constants_probe.Constants¶
Базовые классы: object
Класс для хранения констант

class Consts(CONST_1, CONST_2)

Базовые классы: tuple
CONST_1
Alias for field number 0
CONST_2
Alias for field number 1
consts = Consts(CONST_1=111, CONST_2=222)

print_constants()
Печатает константы

constants_probe.mc¶
псевдоним класса constants_probe.Constants

А хотелось бы, чтобы он делал примерно так:
class constants_probe.Constants¶
Класс для хранения констант

print_constants()
Печатает константы

Офлайн

Board footer

Модераторировать

Powered by DjangoBB

Lo-Fi Version