Přejít na menu

Python documenting: reST and Sphinx

Správa článků

Vyhledávání Vyhledávání
16.5.2014 07:41
,
Počet přečtení: 768
Obrázek ke článku Python documenting: reST and Sphinx

reStructuredText (a.k.a. "reST") format is a plaintext/docstring markup format. Sphinx is the tool to generate documentation from reStructuredText.

Example docstring:

"""My example function
:param param_name: This is the parameter name
:type param_name: str or unicode
:returns: Description of your return value
:rtype: str or unicode
"""

Types are not optional.

Vytvořil 16. května 2014 v 07:52:49 mira. Upravováno 1x, naposledy 16. května 2014 v 07:53:50, mira


Diskuze ke článku

Vložení nového komentáře
*
*
*