четверг, 8 декабря 2016 г.

How can I create documentation with sphinx library

# генерация содержимого папки lib в папку docs/rst
sphinx-apidoc -o docs/rst .

# генерировать документацию
make html

для преодоления ошибок экранируем символы * обратной чертой \
"\*.py"

комментарии пишем с пропуском строки перед аргументами и внимательно относясь к отступам. Например:
text

arg:
   comment

in the comment you can print :
for bold string:
- **parameters**, **types**, **return** and **return types**::

for parametrs

parameters using :param <name>: <description>
type of the parameters :type <name>: <description>
returns using :returns: <description>
examples (doctest)
seealso using .. seealso:: text
notes using .. note:: text
warning using .. warning:: text
todo .. todo:: te

Комментариев нет:

Отправить комментарий

Постоянные читатели