sphinx-http-domain

szfinx-http-domain egy Szfinx plugin hozzá egy HTTP domain, amely lehetővé teszi a dokumentáció RESTful HTTP módszerek.
Akkor a dokumentum egyszerű módszereket, csomagolja érveket az utat a göndör-zárójelben:
.. Http: módszer :: GET / api / foo / bar / {id} / {csiga}
& Nbsp;: arg id: Egy id
& Nbsp;: arg csiga: A meztelen csiga
& Nbsp; Fogadás fenti foobars illő adott id.
Lekérdezési karakterlánc paraméterek is támogatottak:
.. Http: módszer :: GET / api / foo / bar /? Id
& Nbsp;: param id: Egy id
& Nbsp; Keresés listáját foobars illő adott id.
Ez nagyon kezdetleges és kísérleti kód pillanatában.

Telepítés
Fuss pip telepíteni szfinx-http-domain.
Ezután add sphinx_http_domain a conf.py:
kiterjesztések = ['sphinx_http_domain']

követelmények :

• Python
• Sphinx