Настройка методов подписи в sphinx - PullRequest
3 голосов
/ 07 мая 2019

Есть простой способ отформатировать сигнатуру методов в sphinx?Я использую RTD Theme и строю в html.

Проблемы, с которыми я сталкиваюсь на данный момент:

  • аннотации пользовательских типов, созданные с помощью модуля ввода, печатаются в ихполная форма, но я бы хотел, чтобы печаталось только их имя (например, CustomType = Union[type1, type2, type3] должно отображаться как просто CustomType, но вместо этого выводится как Union[type1, type2, type3])

  • методподпись печатается в одну строку, я хотел бы, чтобы она печаталась в виде пользовательской формы с отступом

  • подпись метода должна выделять синтаксис как в IDE

Я не уверен, как выполнить эти настройки, мне кажется, что в html theme conf нет никакой возможности сделать это.

Первое, что я попробовал, было что-то вроде этот код , но я вроде застрял.

В первый момент я также подумал о том, чтобы сделать разветвление сфинкса (как этот пользователь пытался решить другую досадную проблему [PR] ), но потом я понял, что что-то вродеЭто действительно сложно, если вы не очень хорошо знаете проект ...

Я предоставлю дополнительную информацию, если это необходимо.

...