sphinx-http-domain

sfinks-http-domæne er en Sphinx plugin for at tilføje en HTTP domæne, så dokumentationen af ​​hvilende HTTP metoder.
Du kan dokumentere simple metoder, wrap nogen argumenter i stien med krøllede-seler:
.. Http: metode :: GET / api / foo / bar / {id} / {slug}
& Nbsp;: arg id: En id
& Nbsp;: arg slug: En slug
& Nbsp; Hent liste over foobars matchende givet id.
String forespørgsel parametre understøttes også:
.. Http:? Metode :: GET / api / foo / bar / id
& Nbsp;: param id: En id
& Nbsp; Søg efter en liste over foobars matchende givet id.
Dette er meget rudimentære og eksperimentel kode i det øjeblik.

Installation
Kør pip installere sfinks-http-domæne.
Derefter skal du føje sphinx_http_domain til din conf.py:
extensions = ['sphinx_http_domain']

Krav :

• Python
• Sphinx