Python Sphinx - документация документации не отображается должным образом - PullRequest
Новая
       6

Python Sphinx - документация документации не отображается должным образом

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

Я работаю с инструментом Python Sphinx для документирования своего кода. Я создал HTML для простого проекта. В моих строках документации я использую аннотации :param и :type для переменных моих функций, но Sphinx выводит их в HTML, как это, что немного уродливо и очень неясно для читателя:

https://i.stack.imgur.com/MY276.png

Я попытался отредактировать файл "conf.py", но безуспешно. Есть ли способ изменить вывод docstring в htmls, который генерирует Sphinx?

Заранее спасибо!

Редактировать: Это источник для функции "say_hello_twice": 

def say_hello_twice(a, b, c):
    """Random function
    :param a: string
    :param b: string
    :param c: string"""
    print('Hello Sphinx')
    print('Hello Sphinx')
    print(a + b + c)

Когда я включил :type, вывод остался прежним. Выше приведен пример.

...