получить pydoc help (), чтобы игнорировать синтаксис reST (sphinx)? - PullRequest
Новая
       33

получить pydoc help (), чтобы игнорировать синтаксис reST (sphinx)?

0 голосов
/ 08 марта 2019

У меня есть несколько определений функций, таких как: 

def abc(arrg1):
    """
    do something
    :param arrg1: a string like ``'gogo'``
    """
    if arrg1=='gogo':
        print('success')

, который генерируется в красивый HTML-документ Sphinx, отформатированный так: 

<b>abc</b>(<i>arrg1</i>)
   do something 

   <b>Parameters:</b><ul><ul><li><b>arrg1</b> – a string like <kbd>'gogo'</kbd></li></ul></ul>

но в интерактивном терминале это выглядит очень странно, особенно для новых пользователей или непрограммистов: 

>>> help(abc)
Help on function abc in module __main__:

abc(arrg1)
    do something
    :param arrg1: a string like ``'gogo'``

Я конкретно имею в виду это: 

``'gogo'``

это действительно бесполезно для новых пользователей, которые часто используют подобные команды помощи pydoc.


Есть ли способ сделать help output более чистым, в основном игнорируя / убирая галочки?
...