Необычные документы на Python в Spyder - PullRequest
0 голосов
/ 03 июля 2018

Я пишу некоторую документацию на Python, используя Spyder в качестве IDE.

Например, у меня есть функция:

def TestFunction(args1,args2):
    """
    General Description

    Args:
        args1: describing
        args2: describing
    Return:
        data
    """
       ...code here....

Можно ли сделать документацию более красивой со словами, выделенными жирным шрифтом, курсивом и т. Д. И т. Д. Любая ссылка?

Спасибо

Ответы [ 2 ]

0 голосов
/ 06 июля 2018

Я часто использую numpy, поэтому я установил numpydoc и он включил «автоматические соединения» в справке под предпочтениями.

help, automatic connections

Отличная работа enter image description here

0 голосов
/ 04 июля 2018

( Сопровождающий Spyder здесь ) Можно сделать ваши документы более интересными, следуя соглашениям о Реструктурированном тексте. Вы можете найти его спецификацию здесь .

...