Итак, я пытался сделать некоторую документацию для моего проекта.Я нашел Сфинкса, и он выглядел великолепно, поэтому я выбрал это.Сейчас я пытаюсь использовать функцию autodoc, однако она не работает должным образом.Сначала я подумал, что это потому, что мои строки документов не первого стиля, однако они таковы.
Это, например, строка документации для функции parse_data:
"""
Parse the data as GET parameters and return it.
:param data: A dictionary containing values for the api call.
:type data dict
:return: A proper GET param string
:rtype str
"""
И это мой .rst файл:
API
===
.. autoclass:: launchlibrary.Api
:members:
.. automethod:: __init__
launchlibrary.Api содержит parse_data, конечно.
Мой результат выглядит так:
Я ожидал, что autodoc будет выглядеть ближе к тому, что доступно в документации по python-twitter API, например:
Кто-нибудь знает, что может происходить?Заранее спасибо!